blob: bf7d8f3f5922e1d89857f5c670e98642be5880d6 [file] [log] [blame]
Andrew Gerrand7cb21a72012-01-19 11:24:54 +11001<!--{
Andrew Gerrand5dd74172013-09-16 15:47:13 +10002 "Title": "Frequently Asked Questions (FAQ)",
Russ Cox10ea6512012-09-24 20:57:01 -04003 "Path": "/doc/faq"
Andrew Gerrand7cb21a72012-01-19 11:24:54 +11004}-->
Russ Cox32274452009-10-22 00:13:51 -07005
6<h2 id="Origins">Origins</h2>
7
8<h3 id="What_is_the_purpose_of_the_project">
9What is the purpose of the project?</h3>
10
11<p>
12No major systems language has emerged in over a decade, but over that time
13the computing landscape has changed tremendously. There are several trends:
Rob Pike93c4a242011-08-06 07:41:55 +100014</p>
Russ Cox32274452009-10-22 00:13:51 -070015
16<ul>
17<li>
18Computers are enormously quicker but software development is not faster.
19<li>
20Dependency management is a big part of software development today but the
Russ Coxe434f1a2009-11-07 17:31:22 -080021&ldquo;header files&rdquo; of languages in the C tradition are antithetical to clean
Russ Cox32274452009-10-22 00:13:51 -070022dependency analysis&mdash;and fast compilation.
23<li>
24There is a growing rebellion against cumbersome type systems like those of
25Java and C++, pushing people towards dynamically typed languages such as
Rob Pike0c2a4792009-11-01 20:50:42 -080026Python and JavaScript.
Russ Cox32274452009-10-22 00:13:51 -070027<li>
28Some fundamental concepts such as garbage collection and parallel computation
29are not well supported by popular systems languages.
30<li>
31The emergence of multicore computers has generated worry and confusion.
32</ul>
33
34<p>
35We believe it's worth trying again with a new language, a concurrent,
36garbage-collected language with fast compilation. Regarding the points above:
Rob Pike93c4a242011-08-06 07:41:55 +100037</p>
Russ Cox32274452009-10-22 00:13:51 -070038
39<ul>
40<li>
Rob Pike0c2a4792009-11-01 20:50:42 -080041It is possible to compile a large Go program in a few seconds on a single computer.
Russ Cox32274452009-10-22 00:13:51 -070042<li>
43Go provides a model for software construction that makes dependency
44analysis easy and avoids much of the overhead of C-style include files and
45libraries.
46<li>
Rob Pike0c2a4792009-11-01 20:50:42 -080047Go's type system has no hierarchy, so no time is spent defining the
48relationships between types. Also, although Go has static types the language
Russ Cox32274452009-10-22 00:13:51 -070049attempts to make types feel lighter weight than in typical OO languages.
50<li>
51Go is fully garbage-collected and provides fundamental support for
52concurrent execution and communication.
53<li>
54By its design, Go proposes an approach for the construction of system
55software on multicore machines.
56</ul>
57
Rob Pike0d5bc0c2013-08-20 06:44:41 +100058<p>
59A much more expansive answer to this question is available in the article,
Andrew Gerrand43ad89d2014-07-25 10:28:39 +100060<a href="//talks.golang.org/2012/splash.article">Go at Google:
Rob Pike0d5bc0c2013-08-20 06:44:41 +100061Language Design in the Service of Software Engineering</a>.
62
Rob Pike8de50802012-07-16 13:31:15 -070063<h3 id="What_is_the_status_of_the_project">
64What is the status of the project?</h3>
65
66<p>
67Go became a public open source project on November 10, 2009.
68After a couple of years of very active design and development, stability was called for and
Andrew Gerrand43ad89d2014-07-25 10:28:39 +100069Go 1 was <a href="//blog.golang.org/2012/03/go-version-1-is-released.html">released</a>
Rob Pike8de50802012-07-16 13:31:15 -070070on March 28, 2012.
Andrew Gerrand48ba6fe2013-10-04 09:45:06 +100071Go 1, which includes a <a href="/ref/spec">language specification</a>,
Rob Pike8de50802012-07-16 13:31:15 -070072<a href="/pkg/">standard libraries</a>,
73and <a href="/cmd/go/">custom tools</a>,
74provides a stable foundation for creating reliable products, projects, and publications.
75</p>
76
77<p>
78With that stability established, we are using Go to develop programs, products, and tools rather than
79actively changing the language and libraries.
80In fact, the purpose of Go 1 is to provide <a href="/doc/go1compat.html">long-term stability</a>.
81Backwards-incompatible changes will not be made to any Go 1 point release.
82We want to use what we have to learn how a future version of Go might look, rather than to play with
83the language underfoot.
84</p>
85
86<p>
87Of course, development will continue on Go itself, but the focus will be on performance, reliability,
88portability and the addition of new functionality such as improved support for internationalization.
89</p>
90
91<p>
92There may well be a Go 2 one day, but not for a few years and it will be influenced by what we learn using Go 1 as it is today.
93</p>
94
Russ Cox32274452009-10-22 00:13:51 -070095<h3 id="What_is_the_origin_of_the_name">
96What is the origin of the name?</h3>
97
98<p>
Russ Coxe434f1a2009-11-07 17:31:22 -080099&ldquo;Ogle&rdquo; would be a good name for a Go debugger.
Evan Shaw64d85762011-05-22 14:56:12 +1000100</p>
Russ Cox32274452009-10-22 00:13:51 -0700101
Rob Pikebdecae92009-11-23 17:34:23 -0800102<h3 id="Whats_the_origin_of_the_mascot">
103What's the origin of the mascot?</h3>
104
105<p>
106The mascot and logo were designed by
107<a href="http://reneefrench.blogspot.com">Renée French</a>, who also designed
108<a href="http://plan9.bell-labs.com/plan9/glenda.html">Glenda</a>,
109the Plan 9 bunny.
110The gopher is derived from one she used for an <a href="http://wfmu.org/">WFMU</a>
111T-shirt design some years ago.
112The logo and mascot are covered by the
113<a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0</a>
114license.
115</p>
116
Andrew Gerrand4164d602010-09-29 16:52:22 +1000117<h3 id="history">
118What is the history of the project?</h3>
119<p>
120Robert Griesemer, Rob Pike and Ken Thompson started sketching the
121goals for a new language on the white board on September 21, 2007.
122Within a few days the goals had settled into a plan to do something
123and a fair idea of what it would be. Design continued part-time in
124parallel with unrelated work. By January 2008, Ken had started work
125on a compiler with which to explore ideas; it generated C code as its
126output. By mid-year the language had become a full-time project and
127had settled enough to attempt a production compiler. In May 2008,
128Ian Taylor independently started on a GCC front end for Go using the
129draft specification. Russ Cox joined in late 2008 and helped move the language
130and libraries from prototype to reality.
131</p>
132
133<p>
Rob Pike93c4a242011-08-06 07:41:55 +1000134Go became a public open source project on November 10, 2009.
135Many people from the community have contributed ideas, discussions, and code.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000136</p>
137
Andrew Gerrand4164d602010-09-29 16:52:22 +1000138<h3 id="creating_a_new_language">
139Why are you creating a new language?</h3>
140<p>
141Go was born out of frustration with existing languages and
142environments for systems programming. Programming had become too
143difficult and the choice of languages was partly to blame. One had to
144choose either efficient compilation, efficient execution, or ease of
145programming; all three were not available in the same mainstream
146language. Programmers who could were choosing ease over
147safety and efficiency by moving to dynamically typed languages such as
148Python and JavaScript rather than C++ or, to a lesser extent, Java.
149</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000150
Andrew Gerrand4164d602010-09-29 16:52:22 +1000151<p>
152Go is an attempt to combine the ease of programming of an interpreted,
153dynamically typed
154language with the efficiency and safety of a statically typed, compiled language.
155It also aims to be modern, with support for networked and multicore
156computing. Finally, it is intended to be <i>fast</i>: it should take
157at most a few seconds to build a large executable on a single computer.
158To meet these goals required addressing a number of
159linguistic issues: an expressive but lightweight type system;
160concurrency and garbage collection; rigid dependency specification;
161and so on. These cannot be addressed well by libraries or tools; a new
162language was called for.
163</p>
164
Rob Pike48ecfc92013-03-27 15:26:57 -0700165<p>
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000166The article <a href="//talks.golang.org/2012/splash.article">Go at Google</a>
Rob Pike48ecfc92013-03-27 15:26:57 -0700167discusses the background and motivation behind the design of the Go language,
168as well as providing more detail about many of the answers presented in this FAQ.
169</p>
170
Andrew Gerrand4164d602010-09-29 16:52:22 +1000171<h3 id="ancestors">
172What are Go's ancestors?</h3>
173<p>
174Go is mostly in the C family (basic syntax),
175with significant input from the Pascal/Modula/Oberon
176family (declarations, packages),
177plus some ideas from languages
178inspired by Tony Hoare's CSP,
179such as Newsqueak and Limbo (concurrency).
180However, it is a new language across the board.
181In every respect the language was designed by thinking
182about what programmers do and how to make programming, at least the
183kind of programming we do, more effective, which means more fun.
184</p>
185
Andrew Gerrand4164d602010-09-29 16:52:22 +1000186<h3 id="principles">
187What are the guiding principles in the design?</h3>
188<p>
189Programming today involves too much bookkeeping, repetition, and
190clerical work. As Dick Gabriel says, &ldquo;Old programs read
191like quiet conversations between a well-spoken research worker and a
192well-studied mechanical colleague, not as a debate with a compiler.
193Who'd have guessed sophistication bought such noise?&rdquo;
194The sophistication is worthwhile&mdash;no one wants to go back to
195the old languages&mdash;but can it be more quietly achieved?
196</p>
197<p>
198Go attempts to reduce the amount of typing in both senses of the word.
199Throughout its design, we have tried to reduce clutter and
200complexity. There are no forward declarations and no header files;
201everything is declared exactly once. Initialization is expressive,
202automatic, and easy to use. Syntax is clean and light on keywords.
203Stuttering (<code>foo.Foo* myFoo = new(foo.Foo)</code>) is reduced by
204simple type derivation using the <code>:=</code>
205declare-and-initialize construct. And perhaps most radically, there
206is no type hierarchy: types just <i>are</i>, they don't have to
207announce their relationships. These simplifications allow Go to be
208expressive yet comprehensible without sacrificing, well, sophistication.
209</p>
210<p>
211Another important principle is to keep the concepts orthogonal.
212Methods can be implemented for any type; structures represent data while
213interfaces represent abstraction; and so on. Orthogonality makes it
214easier to understand what happens when things combine.
215</p>
216
Russ Cox32274452009-10-22 00:13:51 -0700217<h2 id="Usage">Usage</h2>
218
Andrew Gerrand5ec55c52010-09-30 11:23:39 +1000219<h3 id="Is_Google_using_go_internally"> Is Google using Go internally?</h3>
Rob Pike7685a672009-11-09 20:25:45 -0800220
Evan Shaw64d85762011-05-22 14:56:12 +1000221<p>
Oling Cat018e89f2013-01-24 20:46:33 +1100222Yes. There are now several Go programs deployed in
Rob Pikefcfed142012-01-23 08:39:53 -0800223production inside Google. A public example is the server behind
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000224<a href="//golang.org">golang.org</a>.
Rob Pikefcfed142012-01-23 08:39:53 -0800225It's just the <a href="/cmd/godoc"><code>godoc</code></a>
226document server running in a production configuration on
Dave Cheney82cbcb02012-07-11 09:41:08 -0700227<a href="https://developers.google.com/appengine/">Google App Engine</a>.
Evan Shaw64d85762011-05-22 14:56:12 +1000228</p>
Rob Pike7685a672009-11-09 20:25:45 -0800229
Rob Pike48ecfc92013-03-27 15:26:57 -0700230<p>
Emil Hessmanf3de2172014-12-30 06:45:24 +0100231Other examples include the <a href="//github.com/youtube/vitess/">Vitess</a>
Rob Pike48ecfc92013-03-27 15:26:57 -0700232system for large-scale SQL installations and Google's download server, <code>dl.google.com</code>,
233which delivers Chrome binaries and other large installables such as <code>apt-get</code>
234packages.
235</p>
236
Russ Cox32274452009-10-22 00:13:51 -0700237<h3 id="Do_Go_programs_link_with_Cpp_programs">
238Do Go programs link with C/C++ programs?</h3>
239
240<p>
Andrew Gerrand2a5879d2012-03-20 13:50:05 +1100241There are two Go compiler implementations, <code>gc</code>
242(the <code>6g</code> program and friends) and <code>gccgo</code>.
Rob Pike0c2a4792009-11-01 20:50:42 -0800243<code>Gc</code> uses a different calling convention and linker and can
Russ Cox32274452009-10-22 00:13:51 -0700244therefore only be linked with C programs using the same convention.
Oling Cat018e89f2013-01-24 20:46:33 +1100245There is such a C compiler but no C++ compiler.
246<code>Gccgo</code> is a GCC front-end that can, with care, be linked with
247GCC-compiled C or C++ programs.
Evan Shaw64d85762011-05-22 14:56:12 +1000248</p>
Russ Cox32274452009-10-22 00:13:51 -0700249
250<p>
Oling Cat018e89f2013-01-24 20:46:33 +1100251The <a href="/cmd/cgo/">cgo</a> program provides the mechanism for a
252&ldquo;foreign function interface&rdquo; to allow safe calling of
Andrew Gerrand5ec55c52010-09-30 11:23:39 +1000253C libraries from Go code. SWIG extends this capability to C++ libraries.
Evan Shaw64d85762011-05-22 14:56:12 +1000254</p>
255
Russ Cox32274452009-10-22 00:13:51 -0700256
Rob Pike0c2a4792009-11-01 20:50:42 -0800257<h3 id="Does_Go_support_Google_protocol_buffers">
258Does Go support Google's protocol buffers?</h3>
Russ Cox32274452009-10-22 00:13:51 -0700259
260<p>
Rob Pike6b3031b2010-03-23 17:03:28 -0700261A separate open source project provides the necessary compiler plugin and library.
262It is available at
Emil Hessmanf3de2172014-12-30 06:45:24 +0100263<a href="//github.com/golang/protobuf">github.com/golang/protobuf/</a>
Rob Pike6b3031b2010-03-23 17:03:28 -0700264</p>
Russ Cox32274452009-10-22 00:13:51 -0700265
Evan Shaw64d85762011-05-22 14:56:12 +1000266
Russ Cox6301fb42009-12-03 17:23:33 -0800267<h3 id="Can_I_translate_the_Go_home_page">
268Can I translate the Go home page into another language?</h3>
269
270<p>
271Absolutely. We encourage developers to make Go Language sites in their own languages.
Andrew Gerrand08575732010-04-21 14:00:56 +1000272However, if you choose to add the Google logo or branding to your site
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000273(it does not appear on <a href="//golang.org/">golang.org</a>),
Russ Cox6301fb42009-12-03 17:23:33 -0800274you will need to abide by the guidelines at
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000275<a href="//www.google.com/permissions/guidelines.html">www.google.com/permissions/guidelines.html</a>
Russ Cox6301fb42009-12-03 17:23:33 -0800276</p>
277
Russ Cox32274452009-10-22 00:13:51 -0700278<h2 id="Design">Design</h2>
279
Andrew Gerrand4164d602010-09-29 16:52:22 +1000280<h3 id="unicode_identifiers">
281What's up with Unicode identifiers?</h3>
282
283<p>
284It was important to us to extend the space of identifiers from the
285confines of ASCII. Go's rule&mdash;identifier characters must be
286letters or digits as defined by Unicode&mdash;is simple to understand
287and to implement but has restrictions. Combining characters are
288excluded by design, for instance.
289Until there
290is an agreed external definition of what an identifier might be,
291plus a definition of canonicalization of identifiers that guarantees
292no ambiguity, it seemed better to keep combining characters out of
293the mix. Thus we have a simple rule that can be expanded later
294without breaking programs, one that avoids bugs that would surely arise
295from a rule that admits ambiguous identifiers.
296</p>
297
298<p>
299On a related note, since an exported identifier must begin with an
300upper-case letter, identifiers created from &ldquo;letters&rdquo;
301in some languages can, by definition, not be exported. For now the
302only solution is to use something like <code>X日本語</code>, which
303is clearly unsatisfactory; we are considering other options. The
304case-for-visibility rule is unlikely to change however; it's one
305of our favorite features of Go.
306</p>
307
308<h3 id="Why_doesnt_Go_have_feature_X">Why does Go not have feature X?</h3>
Russ Cox32274452009-10-22 00:13:51 -0700309
310<p>
311Every language contains novel features and omits someone's favorite
312feature. Go was designed with an eye on felicity of programming, speed of
313compilation, orthogonality of concepts, and the need to support features
314such as concurrency and garbage collection. Your favorite feature may be
315missing because it doesn't fit, because it affects compilation speed or
316clarity of design, or because it would make the fundamental system model
317too difficult.
Evan Shaw64d85762011-05-22 14:56:12 +1000318</p>
Russ Cox32274452009-10-22 00:13:51 -0700319
320<p>
Rob Pike0c2a4792009-11-01 20:50:42 -0800321If it bothers you that Go is missing feature <var>X</var>,
322please forgive us and investigate the features that Go does have. You might find that
Russ Cox32274452009-10-22 00:13:51 -0700323they compensate in interesting ways for the lack of <var>X</var>.
Evan Shaw64d85762011-05-22 14:56:12 +1000324</p>
Russ Cox32274452009-10-22 00:13:51 -0700325
Andrew Gerrand4164d602010-09-29 16:52:22 +1000326<h3 id="generics">
327Why does Go not have generic types?</h3>
328<p>
329Generics may well be added at some point. We don't feel an urgency for
330them, although we understand some programmers do.
331</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000332
Andrew Gerrand4164d602010-09-29 16:52:22 +1000333<p>
334Generics are convenient but they come at a cost in
335complexity in the type system and run-time. We haven't yet found a
336design that gives value proportionate to the complexity, although we
337continue to think about it. Meanwhile, Go's built-in maps and slices,
338plus the ability to use the empty interface to construct containers
339(with explicit unboxing) mean in many cases it is possible to write
340code that does what generics would enable, if less smoothly.
341</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000342
Andrew Gerrand4164d602010-09-29 16:52:22 +1000343<p>
344This remains an open issue.
345</p>
346
347<h3 id="exceptions">
348Why does Go not have exceptions?</h3>
349<p>
350We believe that coupling exceptions to a control
351structure, as in the <code>try-catch-finally</code> idiom, results in
352convoluted code. It also tends to encourage programmers to label
353too many ordinary errors, such as failing to open a file, as
354exceptional.
355</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000356
Andrew Gerrand4164d602010-09-29 16:52:22 +1000357<p>
Rob Pike93c4a242011-08-06 07:41:55 +1000358Go takes a different approach. For plain error handling, Go's multi-value
359returns make it easy to report an error without overloading the return value.
Shenghou Ma97b13ac2012-03-07 08:15:47 +1100360<a href="/doc/articles/error_handling.html">A canonical error type, coupled
361with Go's other features</a>, makes error handling pleasant but quite different
362from that in other languages.
Rob Pike93c4a242011-08-06 07:41:55 +1000363</p>
364
365<p>
366Go also has a couple
Andrew Gerrand4164d602010-09-29 16:52:22 +1000367of built-in functions to signal and recover from truly exceptional
368conditions. The recovery mechanism is executed only as part of a
369function's state being torn down after an error, which is sufficient
370to handle catastrophe but requires no extra control structures and,
371when used well, can result in clean error-handling code.
372</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000373
Andrew Gerrand5ec55c52010-09-30 11:23:39 +1000374<p>
Shenghou Ma97b13ac2012-03-07 08:15:47 +1100375See the <a href="/doc/articles/defer_panic_recover.html">Defer, Panic, and Recover</a> article for details.
Andrew Gerrand5ec55c52010-09-30 11:23:39 +1000376</p>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000377
Andrew Gerrand4164d602010-09-29 16:52:22 +1000378<h3 id="assertions">
379Why does Go not have assertions?</h3>
Russ Cox32274452009-10-22 00:13:51 -0700380
381<p>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000382Go doesn't provide assertions. They are undeniably convenient, but our
383experience has been that programmers use them as a crutch to avoid thinking
384about proper error handling and reporting. Proper error handling means that
385servers continue operation after non-fatal errors instead of crashing.
386Proper error reporting means that errors are direct and to the point,
387saving the programmer from interpreting a large crash trace. Precise
388errors are particularly important when the programmer seeing the errors is
389not familiar with the code.
Evan Shaw64d85762011-05-22 14:56:12 +1000390</p>
Russ Cox32274452009-10-22 00:13:51 -0700391
Andrew Gerrand4164d602010-09-29 16:52:22 +1000392<p>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000393We understand that this is a point of contention. There are many things in
394the Go language and libraries that differ from modern practices, simply
395because we feel it's sometimes worth trying a different approach.
Evan Shaw64d85762011-05-22 14:56:12 +1000396</p>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000397
398<h3 id="csp">
399Why build concurrency on the ideas of CSP?</h3>
400<p>
401Concurrency and multi-threaded programming have a reputation
Rob Pikefcfed142012-01-23 08:39:53 -0800402for difficulty. We believe this is due partly to complex
Andrew Gerrand4164d602010-09-29 16:52:22 +1000403designs such as pthreads and partly to overemphasis on low-level details
Rob Pike93c4a242011-08-06 07:41:55 +1000404such as mutexes, condition variables, and memory barriers.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000405Higher-level interfaces enable much simpler code, even if there are still
406mutexes and such under the covers.
407</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000408
Andrew Gerrand4164d602010-09-29 16:52:22 +1000409<p>
410One of the most successful models for providing high-level linguistic support
411for concurrency comes from Hoare's Communicating Sequential Processes, or CSP.
412Occam and Erlang are two well known languages that stem from CSP.
413Go's concurrency primitives derive from a different part of the family tree
414whose main contribution is the powerful notion of channels as first class objects.
Rob Pike48ecfc92013-03-27 15:26:57 -0700415Experience with several earlier languages has shown that the CSP model
416fits well into a procedural language framework.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000417</p>
418
419<h3 id="goroutines">
420Why goroutines instead of threads?</h3>
421<p>
422Goroutines are part of making concurrency easy to use. The idea, which has
423been around for a while, is to multiplex independently executing
Rob Pike93c4a242011-08-06 07:41:55 +1000424functions&mdash;coroutines&mdash;onto a set of threads.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000425When a coroutine blocks, such as by calling a blocking system call,
426the run-time automatically moves other coroutines on the same operating
427system thread to a different, runnable thread so they won't be blocked.
428The programmer sees none of this, which is the point.
Rob Pike287967f2014-03-21 13:59:30 +1100429The result, which we call goroutines, can be very cheap: they have little
430overhead beyond the memory for the stack, which is just a few kilobytes.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000431</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000432
Andrew Gerrand4164d602010-09-29 16:52:22 +1000433<p>
Rob Pike287967f2014-03-21 13:59:30 +1100434To make the stacks small, Go's run-time uses resizable, bounded stacks. A newly
Andrew Gerrand4164d602010-09-29 16:52:22 +1000435minted goroutine is given a few kilobytes, which is almost always enough.
Rob Pike287967f2014-03-21 13:59:30 +1100436When it isn't, the run-time grows (and shrinks) the memory for storing
437the stack automatically, allowing many goroutines to live in a modest
438amount of memory.
439The CPU overhead averages about three cheap instructions per function call.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000440It is practical to create hundreds of thousands of goroutines in the same
Rob Pike287967f2014-03-21 13:59:30 +1100441address space.
442If goroutines were just threads, system resources would
Andrew Gerrand4164d602010-09-29 16:52:22 +1000443run out at a much smaller number.
444</p>
445
446<h3 id="atomic_maps">
447Why are map operations not defined to be atomic?</h3>
448
449<p>
450After long discussion it was decided that the typical use of maps did not require
Ian Lance Taylor81896052013-12-12 18:48:40 -0800451safe access from multiple goroutines, and in those cases where it did, the map was
Andrew Gerrand4164d602010-09-29 16:52:22 +1000452probably part of some larger data structure or computation that was already
453synchronized. Therefore requiring that all map operations grab a mutex would slow
454down most programs and add safety to few. This was not an easy decision,
455however, since it means uncontrolled map access can crash the program.
456</p>
457
458<p>
459The language does not preclude atomic map updates. When required, such
460as when hosting an untrusted program, the implementation could interlock
461map access.
462</p>
463
Andrew Gerrand61dbc342013-05-06 15:02:56 -0700464<h3 id="language_changes">
465Will you accept my language change?</h3>
466
467<p>
468People often suggest improvements to the language—the
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000469<a href="//groups.google.com/group/golang-nuts">mailing list</a>
Andrew Gerrand61dbc342013-05-06 15:02:56 -0700470contains a rich history of such discussions—but very few of these changes have
471been accepted.
472</p>
473
474<p>
475Although Go is an open source project, the language and libraries are protected
476by a <a href="/doc/go1compat.html">compatibility promise</a> that prevents
477changes that break existing programs.
478If your proposal violates the Go 1 specification we cannot even entertain the
479idea, regardless of its merit.
480A future major release of Go may be incompatible with Go 1, but we're not ready
481to start talking about what that might be.
482</p>
483
484<p>
Rob Pike61f3fdc2013-08-25 23:50:44 +1000485Even if your proposal is compatible with the Go 1 spec, it might
Andrew Gerrand61dbc342013-05-06 15:02:56 -0700486not be in the spirit of Go's design goals.
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000487The article <i><a href="//talks.golang.org/2012/splash.article">Go
Andrew Gerrand61dbc342013-05-06 15:02:56 -0700488at Google: Language Design in the Service of Software Engineering</a></i>
489explains Go's origins and the motivation behind its design.
490</p>
491
Andrew Gerrand4164d602010-09-29 16:52:22 +1000492<h2 id="types">Types</h2>
Russ Cox32274452009-10-22 00:13:51 -0700493
494<h3 id="Is_Go_an_object-oriented_language">
495Is Go an object-oriented language?</h3>
496
497<p>
498Yes and no. Although Go has types and methods and allows an
499object-oriented style of programming, there is no type hierarchy.
Russ Coxe434f1a2009-11-07 17:31:22 -0800500The concept of &ldquo;interface&rdquo; in Go provides a different approach that
Russ Cox32274452009-10-22 00:13:51 -0700501we believe is easy to use and in some ways more general. There are
502also ways to embed types in other types to provide something
503analogous&mdash;but not identical&mdash;to subclassing.
Rob Pike0c2a4792009-11-01 20:50:42 -0800504Moreover, methods in Go are more general than in C++ or Java:
Rob Pikefcfed142012-01-23 08:39:53 -0800505they can be defined for any sort of data, even built-in types such
506as plain, &ldquo;unboxed&rdquo; integers.
507They are not restricted to structs (classes).
Evan Shaw64d85762011-05-22 14:56:12 +1000508</p>
Russ Cox32274452009-10-22 00:13:51 -0700509
510<p>
Rob Pike0c2a4792009-11-01 20:50:42 -0800511Also, the lack of type hierarchy makes &ldquo;objects&rdquo; in Go feel much more
Russ Coxe434f1a2009-11-07 17:31:22 -0800512lightweight than in languages such as C++ or Java.
Evan Shaw64d85762011-05-22 14:56:12 +1000513</p>
Russ Cox32274452009-10-22 00:13:51 -0700514
515<h3 id="How_do_I_get_dynamic_dispatch_of_methods">
516How do I get dynamic dispatch of methods?</h3>
517
518<p>
519The only way to have dynamically dispatched methods is through an
Rob Pikefcfed142012-01-23 08:39:53 -0800520interface. Methods on a struct or any other concrete type are always resolved statically.
Evan Shaw64d85762011-05-22 14:56:12 +1000521</p>
Russ Cox32274452009-10-22 00:13:51 -0700522
Andrew Gerrand4164d602010-09-29 16:52:22 +1000523<h3 id="inheritance">
524Why is there no type inheritance?</h3>
525<p>
526Object-oriented programming, at least in the best-known languages,
527involves too much discussion of the relationships between types,
528relationships that often could be derived automatically. Go takes a
529different approach.
530</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000531
Andrew Gerrand4164d602010-09-29 16:52:22 +1000532<p>
533Rather than requiring the programmer to declare ahead of time that two
534types are related, in Go a type automatically satisfies any interface
535that specifies a subset of its methods. Besides reducing the
536bookkeeping, this approach has real advantages. Types can satisfy
537many interfaces at once, without the complexities of traditional
538multiple inheritance.
Rob Pike93c4a242011-08-06 07:41:55 +1000539Interfaces can be very lightweight&mdash;an interface with
540one or even zero methods can express a useful concept.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000541Interfaces can be added after the fact if a new idea comes along
542or for testing&mdash;without annotating the original types.
543Because there are no explicit relationships between types
544and interfaces, there is no type hierarchy to manage or discuss.
545</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000546
Andrew Gerrand4164d602010-09-29 16:52:22 +1000547<p>
548It's possible to use these ideas to construct something analogous to
549type-safe Unix pipes. For instance, see how <code>fmt.Fprintf</code>
550enables formatted printing to any output, not just a file, or how the
551<code>bufio</code> package can be completely separate from file I/O,
Rob Pike86494442011-11-08 16:26:03 -0800552or how the <code>image</code> packages generate compressed
553image files. All these ideas stem from a single interface
Andrew Gerrand4164d602010-09-29 16:52:22 +1000554(<code>io.Writer</code>) representing a single method
555(<code>Write</code>). And that's only scratching the surface.
Rob Pike5cff1902012-02-20 12:42:50 +1100556Go's interfaces have a profound influence on how programs are structured.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000557</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000558
Andrew Gerrand4164d602010-09-29 16:52:22 +1000559<p>
560It takes some getting used to but this implicit style of type
Rob Pike93c4a242011-08-06 07:41:55 +1000561dependency is one of the most productive things about Go.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000562</p>
563
564<h3 id="methods_on_basics">
565Why is <code>len</code> a function and not a method?</h3>
566<p>
567We debated this issue but decided
568implementing <code>len</code> and friends as functions was fine in practice and
569didn't complicate questions about the interface (in the Go type sense)
570of basic types.
571</p>
572
573<h3 id="overloading">
574Why does Go not support overloading of methods and operators?</h3>
575<p>
576Method dispatch is simplified if it doesn't need to do type matching as well.
577Experience with other languages told us that having a variety of
578methods with the same name but different signatures was occasionally useful
579but that it could also be confusing and fragile in practice. Matching only by name
580and requiring consistency in the types was a major simplifying decision
581in Go's type system.
582</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000583
Andrew Gerrand4164d602010-09-29 16:52:22 +1000584<p>
585Regarding operator overloading, it seems more a convenience than an absolute
586requirement. Again, things are simpler without it.
587</p>
588
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100589<h3 id="implements_interface">
590Why doesn't Go have "implements" declarations?</h3>
591
592<p>
593A Go type satisfies an interface by implementing the methods of that interface,
594nothing more. This property allows interfaces to be defined and used without
Rob Pike4be9b832012-09-07 14:01:02 -0700595having to modify existing code. It enables a kind of structural typing that
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100596promotes separation of concerns and improves code re-use, and makes it easier
597to build on patterns that emerge as the code develops.
598The semantics of interfaces is one of the main reasons for Go's nimble,
599lightweight feel.
600</p>
601
602<p>
603See the <a href="#inheritance">question on type inheritance</a> for more detail.
604</p>
605
606<h3 id="guarantee_satisfies_interface">
607How can I guarantee my type satisfies an interface?</h3>
608
609<p>
610You can ask the compiler to check that the type <code>T</code> implements the
611interface <code>I</code> by attempting an assignment:
612</p>
613
614<pre>
615type T struct{}
Rob Pikefcfed142012-01-23 08:39:53 -0800616var _ I = T{} // Verify that T implements I.
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100617</pre>
618
619<p>
620If <code>T</code> doesn't implement <code>I</code>, the mistake will be caught
621at compile time.
622</p>
623
624<p>
625If you wish the users of an interface to explicitly declare that they implement
626it, you can add a method with a descriptive name to the interface's method set.
627For example:
628</p>
629
630<pre>
631type Fooer interface {
Rob Pikefcfed142012-01-23 08:39:53 -0800632 Foo()
633 ImplementsFooer()
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100634}
635</pre>
636
637<p>
638A type must then implement the <code>ImplementsFooer</code> method to be a
Andrew Gerrand393ea2d2011-03-17 16:37:34 +1100639<code>Fooer</code>, clearly documenting the fact and announcing it in
640<a href="/cmd/godoc/">godoc</a>'s output.
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100641</p>
642
643<pre>
644type Bar struct{}
645func (b Bar) ImplementsFooer() {}
646func (b Bar) Foo() {}
647</pre>
648
649<p>
Oling Cat018e89f2013-01-24 20:46:33 +1100650Most code doesn't make use of such constraints, since they limit the utility of
Andrew Gerrandaef4e1c2011-03-04 13:11:07 +1100651the interface idea. Sometimes, though, they're necessary to resolve ambiguities
652among similar interfaces.
653</p>
654
Rob Pike93c4a242011-08-06 07:41:55 +1000655<h3 id="t_and_equal_interface">
656Why doesn't type T satisfy the Equal interface?</h3>
657
658<p>
659Consider this simple interface to represent an object that can compare
660itself with another value:
661</p>
662
663<pre>
664type Equaler interface {
Rob Pikefcfed142012-01-23 08:39:53 -0800665 Equal(Equaler) bool
Rob Pike93c4a242011-08-06 07:41:55 +1000666}
667</pre>
668
669<p>
670and this type, <code>T</code>:
671</p>
672
673<pre>
674type T int
675func (t T) Equal(u T) bool { return t == u } // does not satisfy Equaler
676</pre>
677
678<p>
679Unlike the analogous situation in some polymorphic type systems,
680<code>T</code> does not implement <code>Equaler</code>.
681The argument type of <code>T.Equal</code> is <code>T</code>,
682not literally the required type <code>Equaler</code>.
683</p>
684
685<p>
686In Go, the type system does not promote the argument of
687<code>Equal</code>; that is the programmer's responsibility, as
688illustrated by the type <code>T2</code>, which does implement
689<code>Equaler</code>:
690</p>
691
692<pre>
693type T2 int
694func (t T2) Equal(u Equaler) bool { return t == u.(T2) } // satisfies Equaler
695</pre>
696
697<p>
698Even this isn't like other type systems, though, because in Go <em>any</em>
699type that satisfies <code>Equaler</code> could be passed as the
700argument to <code>T2.Equal</code>, and at run time we must
701check that the argument is of type <code>T2</code>.
702Some languages arrange to make that guarantee at compile time.
703</p>
704
705<p>
706A related example goes the other way:
707</p>
708
709<pre>
710type Opener interface {
David Symondsc9121502013-05-22 12:28:58 +1000711 Open() Reader
Rob Pike93c4a242011-08-06 07:41:55 +1000712}
713
714func (t T3) Open() *os.File
715</pre>
716
717<p>
718In Go, <code>T3</code> does not satisfy <code>Opener</code>,
719although it might in another language.
720</p>
721
722<p>
723While it is true that Go's type system does less for the programmer
724in such cases, the lack of subtyping makes the rules about
725interface satisfaction very easy to state: are the function's names
726and signatures exactly those of the interface?
727Go's rule is also easy to implement efficiently.
728We feel these benefits offset the lack of
729automatic type promotion. Should Go one day adopt some form of generic
730typing, we expect there would be a way to express the idea of these
731examples and also have them be statically checked.
732</p>
733
Andrew Gerrand17805dd2011-06-18 20:31:38 +1000734<h3 id="convert_slice_of_interface">
735Can I convert a []T to an []interface{}?</h3>
736
737<p>
Rob Pike86494442011-11-08 16:26:03 -0800738Not directly, because they do not have the same representation in memory.
Andrew Gerrand17805dd2011-06-18 20:31:38 +1000739It is necessary to copy the elements individually to the destination
740slice. This example converts a slice of <code>int</code> to a slice of
741<code>interface{}</code>:
742</p>
743
744<pre>
745t := []int{1, 2, 3, 4}
746s := make([]interface{}, len(t))
747for i, v := range t {
Rob Pikefcfed142012-01-23 08:39:53 -0800748 s[i] = v
Andrew Gerrand17805dd2011-06-18 20:31:38 +1000749}
750</pre>
751
Rob Pike1e0f97a2012-02-17 16:27:17 +1100752<h3 id="nil_error">
753Why is my nil error value not equal to nil?
754</h3>
755
756<p>
757Under the covers, interfaces are implemented as two elements, a type and a value.
758The value, called the interface's dynamic value,
759is an arbitrary concrete value and the type is that of the value.
760For the <code>int</code> value 3, an interface value contains,
761schematically, (<code>int</code>, <code>3</code>).
762</p>
763
764<p>
765An interface value is <code>nil</code> only if the inner value and type are both unset,
766(<code>nil</code>, <code>nil</code>).
767In particular, a <code>nil</code> interface will always hold a <code>nil</code> type.
768If we store a pointer of type <code>*int</code> inside
769an interface value, the inner type will be <code>*int</code> regardless of the value of the pointer:
770(<code>*int</code>, <code>nil</code>).
771Such an interface value will therefore be non-<code>nil</code>
772<em>even when the pointer inside is</em> <code>nil</code>.
773</p>
774
775<p>
776This situation can be confusing, and often arises when a <code>nil</code> value is
777stored inside an interface value such as an <code>error</code> return:
778</p>
779
780<pre>
781func returnsError() error {
782 var p *MyError = nil
783 if bad() {
784 p = ErrBad
785 }
786 return p // Will always return a non-nil error.
787}
788</pre>
789
790<p>
791If all goes well, the function returns a <code>nil</code> <code>p</code>,
792so the return value is an <code>error</code> interface
793value holding (<code>*MyError</code>, <code>nil</code>).
794This means that if the caller compares the returned error to <code>nil</code>,
795it will always look as if there was an error even if nothing bad happened.
796To return a proper <code>nil</code> <code>error</code> to the caller,
797the function must return an explicit <code>nil</code>:
798</p>
799
800
801<pre>
802func returnsError() error {
803 if bad() {
804 return ErrBad
805 }
806 return nil
807}
808</pre>
809
810<p>
811It's a good idea for functions
812that return errors always to use the <code>error</code> type in
813their signature (as we did above) rather than a concrete type such
814as <code>*MyError</code>, to help guarantee the error is
815created correctly. As an example,
816<a href="/pkg/os/#Open"><code>os.Open</code></a>
817returns an <code>error</code> even though, if not <code>nil</code>,
818it's always of concrete type
819<a href="/pkg/os/#PathError"><code>*os.PathError</code></a>.
820</p>
821
822<p>
823Similar situations to those described here can arise whenever interfaces are used.
824Just keep in mind that if any concrete value
825has been stored in the interface, the interface will not be <code>nil</code>.
826For more information, see
Shenghou Macb6c09a2012-03-01 14:54:35 +0800827<a href="/doc/articles/laws_of_reflection.html">The Laws of Reflection</a>.
Rob Pike1e0f97a2012-02-17 16:27:17 +1100828</p>
829
830
Rob Pike7d87f3d2011-08-06 11:21:59 +1000831<h3 id="unions">
832Why are there no untagged unions, as in C?</h3>
833
834<p>
835Untagged unions would violate Go's memory safety
836guarantees.
837</p>
838
839<h3 id="variant_types">
840Why does Go not have variant types?</h3>
841
842<p>
843Variant types, also known as algebraic types, provide a way to specify
844that a value might take one of a set of other types, but only those
845types. A common example in systems programming would specify that an
846error is, say, a network error, a security error or an application
847error and allow the caller to discriminate the source of the problem
848by examining the type of the error. Another example is a syntax tree
849in which each node can be a different type: declaration, statement,
850assignment and so on.
851</p>
852
853<p>
854We considered adding variant types to Go, but after discussion
855decided to leave them out because they overlap in confusing ways
856with interfaces. What would happen if the elements of a variant type
857were themselves interfaces?
858</p>
859
860<p>
861Also, some of what variant types address is already covered by the
862language. The error example is easy to express using an interface
863value to hold the error and a type switch to discriminate cases. The
864syntax tree example is also doable, although not as elegantly.
865</p>
866
Andrew Gerrand4164d602010-09-29 16:52:22 +1000867<h2 id="values">Values</h2>
868
869<h3 id="conversions">
870Why does Go not provide implicit numeric conversions?</h3>
871<p>
872The convenience of automatic conversion between numeric types in C is
873outweighed by the confusion it causes. When is an expression unsigned?
874How big is the value? Does it overflow? Is the result portable, independent
875of the machine on which it executes?
876It also complicates the compiler; &ldquo;the usual arithmetic conversions&rdquo;
877are not easy to implement and inconsistent across architectures.
878For reasons of portability, we decided to make things clear and straightforward
879at the cost of some explicit conversions in the code.
880The definition of constants in Go&mdash;arbitrary precision values free
881of signedness and size annotations&mdash;ameliorates matters considerably,
882though.
883</p>
Evan Shaw64d85762011-05-22 14:56:12 +1000884
Andrew Gerrand4164d602010-09-29 16:52:22 +1000885<p>
886A related detail is that, unlike in C, <code>int</code> and <code>int64</code>
887are distinct types even if <code>int</code> is a 64-bit type. The <code>int</code>
888type is generic; if you care about how many bits an integer holds, Go
889encourages you to be explicit.
890</p>
891
Rob Pike56c4d0a2014-09-27 11:56:54 -0700892<p>
893A blog post, title <a href="http://blog.golang.org/constants">Constants</a>,
894explores this topic in more detail.
895</p>
896
Andrew Gerrand4164d602010-09-29 16:52:22 +1000897<h3 id="builtin_maps">
898Why are maps built in?</h3>
899<p>
900The same reason strings are: they are such a powerful and important data
901structure that providing one excellent implementation with syntactic support
902makes programming more pleasant. We believe that Go's implementation of maps
903is strong enough that it will serve for the vast majority of uses.
904If a specific application can benefit from a custom implementation, it's possible
905to write one but it will not be as convenient syntactically; this seems a reasonable tradeoff.
906</p>
907
Andrew Gerrand4164d602010-09-29 16:52:22 +1000908<h3 id="map_keys">
Rob Pikefcfed142012-01-23 08:39:53 -0800909Why don't maps allow slices as keys?</h3>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000910<p>
Rob Pikefcfed142012-01-23 08:39:53 -0800911Map lookup requires an equality operator, which slices do not implement.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000912They don't implement equality because equality is not well defined on such types;
913there are multiple considerations involving shallow vs. deep comparison, pointer vs.
Rob Pikefcfed142012-01-23 08:39:53 -0800914value comparison, how to deal with recursive types, and so on.
915We may revisit this issue&mdash;and implementing equality for slices
Andrew Gerrand4164d602010-09-29 16:52:22 +1000916will not invalidate any existing programs&mdash;but without a clear idea of what
Rob Pike5cff1902012-02-20 12:42:50 +1100917equality of slices should mean, it was simpler to leave it out for now.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000918</p>
919
Rob Pikefcfed142012-01-23 08:39:53 -0800920<p>
Rob Pike5cff1902012-02-20 12:42:50 +1100921In Go 1, unlike prior releases, equality is defined for structs and arrays, so such
922types can be used as map keys. Slices still do not have a definition of equality, though.
Rob Pikefcfed142012-01-23 08:39:53 -0800923</p>
924
Andrew Gerrand4164d602010-09-29 16:52:22 +1000925<h3 id="references">
926Why are maps, slices, and channels references while arrays are values?</h3>
927<p>
928There's a lot of history on that topic. Early on, maps and channels
929were syntactically pointers and it was impossible to declare or use a
930non-pointer instance. Also, we struggled with how arrays should work.
931Eventually we decided that the strict separation of pointers and
Rob Pike48ecfc92013-03-27 15:26:57 -0700932values made the language harder to use. Changing these
933types to act as references to the associated, shared data structures resolved
934these issues. This change added some regrettable complexity to the
935language but had a large effect on usability: Go became a more
936productive, comfortable language when it was introduced.
Andrew Gerrand4164d602010-09-29 16:52:22 +1000937</p>
938
Russ Cox32274452009-10-22 00:13:51 -0700939<h2 id="Writing_Code">Writing Code</h2>
940
941<h3 id="How_are_libraries_documented">
942How are libraries documented?</h3>
943
944<p>
945There is a program, <code>godoc</code>, written in Go, that extracts
946package documentation from the source code. It can be used on the
947command line or on the web. An instance is running at
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000948<a href="/pkg/">golang.org/pkg/</a>.
Russ Coxe434f1a2009-11-07 17:31:22 -0800949In fact, <code>godoc</code> implements the full site at
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000950<a href="/">golang.org/</a>.
Evan Shaw64d85762011-05-22 14:56:12 +1000951</p>
Russ Cox32274452009-10-22 00:13:51 -0700952
953<h3 id="Is_there_a_Go_programming_style_guide">
954Is there a Go programming style guide?</h3>
955
956<p>
Rob Pike0c2a4792009-11-01 20:50:42 -0800957Eventually, there may be a small number of rules to guide things
958like naming, layout, and file organization.
959The document <a href="effective_go.html">Effective Go</a>
960contains some style advice.
961More directly, the program <code>gofmt</code> is a pretty-printer
962whose purpose is to enforce layout rules; it replaces the usual
963compendium of do's and don'ts that allows interpretation.
964All the Go code in the repository has been run through <code>gofmt</code>.
Evan Shaw64d85762011-05-22 14:56:12 +1000965</p>
Russ Cox32274452009-10-22 00:13:51 -0700966
Rob Pike3a7fe362014-03-06 13:15:09 +1100967<p>
968The document titled
Andrew Gerrand43ad89d2014-07-25 10:28:39 +1000969<a href="//golang.org/s/comments">Go Code Review Comments</a>
Rob Pike3a7fe362014-03-06 13:15:09 +1100970is a collection of very short essays about details of Go idiom that are often
971missed by programmers.
972It is a handy reference for people doing code reviews for Go projects.
973</p>
974
Russ Cox32274452009-10-22 00:13:51 -0700975<h3 id="How_do_I_submit_patches_to_the_Go_libraries">
976How do I submit patches to the Go libraries?</h3>
977
Rob Pike0c2a4792009-11-01 20:50:42 -0800978<p>
Rob Pike56c4d0a2014-09-27 11:56:54 -0700979The library sources are in the <code>src</code> directory of the repository.
Rob Pike0c2a4792009-11-01 20:50:42 -0800980If you want to make a significant change, please discuss on the mailing list before embarking.
Evan Shaw64d85762011-05-22 14:56:12 +1000981</p>
Russ Cox32274452009-10-22 00:13:51 -0700982
Rob Pike0c2a4792009-11-01 20:50:42 -0800983<p>
984See the document
985<a href="contribute.html">Contributing to the Go project</a>
986for more information about how to proceed.
Evan Shaw64d85762011-05-22 14:56:12 +1000987</p>
Andrew Gerrand4164d602010-09-29 16:52:22 +1000988
Herbert Georg Fischer99021b72013-03-15 13:43:10 -0700989<h3 id="git_https">
990Why does "go get" use HTTPS when cloning a repository?</h3>
991
992<p>
993Companies often permit outgoing traffic only on the standard TCP ports 80 (HTTP)
994and 443 (HTTPS), blocking outgoing traffic on other ports, including TCP port 9418
995(git) and TCP port 22 (SSH).
996When using HTTPS instead of HTTP, <code>git</code> enforces certificate validation by
997default, providing protection against man-in-the-middle, eavesdropping and tampering attacks.
998The <code>go get</code> command therefore uses HTTPS for safety.
999</p>
1000
1001<p>
1002If you use <code>git</code> and prefer to push changes through SSH using your existing key
1003it's easy to work around this. For GitHub, try one of these solutions:
1004</p>
1005<ul>
1006<li>Manually clone the repository in the expected package directory:
1007<pre>
1008$ cd $GOPATH/src/github.com/username
1009$ git clone git@github.com:username/package.git
1010</pre>
1011</li>
1012<li>Force <code>git push</code> to use the <code>SSH</code> protocol by appending
1013these two lines to <code>~/.gitconfig</code>:
1014<pre>
1015[url "git@github.com:"]
1016 pushInsteadOf = https://github.com/
1017</pre>
1018</li>
1019</ul>
1020
Russ Coxdc8d9032013-10-03 09:18:47 -04001021<h3 id="get_version">
1022How should I manage package versions using "go get"?</h3>
1023
1024<p>
1025"Go get" does not have any explicit concept of package versions.
1026Versioning is a source of significant complexity, especially in large code bases,
1027and we are unaware of any approach that works well at scale in a large enough
1028variety of situations to be appropriate to force on all Go users.
1029What "go get" and the larger Go toolchain do provide is isolation of
1030packages with different import paths.
1031For example, the standard library's <code>html/template</code> and <code>text/template</code>
1032coexist even though both are "package template".
1033This observation leads to some advice for package authors and package users.
1034</p>
1035
1036<p>
1037Packages intended for public use should try to maintain backwards compatibility as they evolve.
1038The <a href="/doc/go1compat.html">Go 1 compatibility guidelines</a> are a good reference here:
1039don't remove exported names, encourage tagged composite literals, and so on.
1040If different functionality is required, add a new name instead of changing an old one.
1041If a complete break is required, create a new package with a new import path.</p>
1042
1043<p>
1044If you're using an externally supplied package and worry that it might change in
1045unexpected ways, the simplest solution is to copy it to your local repository.
1046(This is the approach Google takes internally.)
1047Store the copy under a new import path that identifies it as a local copy.
1048For example, you might copy "original.com/pkg" to "you.com/external/original.com/pkg".
1049Keith Rarick's <a href="https://github.com/kr/goven">goven</a> is one tool to help automate this process.
1050</p>
1051
Andrew Gerrand4164d602010-09-29 16:52:22 +10001052<h2 id="Pointers">Pointers and Allocation</h2>
1053
1054<h3 id="pass_by_value">
1055When are function parameters passed by value?</h3>
Russ Cox32274452009-10-22 00:13:51 -07001056
1057<p>
Rob Pike86494442011-11-08 16:26:03 -08001058As in all languages in the C family, everything in Go is passed by value.
1059That is, a function always gets a copy of the
Andrew Gerrand4164d602010-09-29 16:52:22 +10001060thing being passed, as if there were an assignment statement assigning the
Rob Pike86494442011-11-08 16:26:03 -08001061value to the parameter. For instance, passing an <code>int</code> value
1062to a function makes a copy of the <code>int</code>, and passing a pointer
1063value makes a copy of the pointer, but not the data it points to.
1064(See the next section for a discussion of how this affects method receivers.)
Andrew Gerrand4164d602010-09-29 16:52:22 +10001065</p>
Russ Cox32274452009-10-22 00:13:51 -07001066
1067<p>
Rob Pikefcfed142012-01-23 08:39:53 -08001068Map and slice values behave like pointers: they are descriptors that
Andrew Gerrand4164d602010-09-29 16:52:22 +10001069contain pointers to the underlying map or slice data. Copying a map or
1070slice value doesn't copy the data it points to. Copying an interface value
1071makes a copy of the thing stored in the interface value. If the interface
1072value holds a struct, copying the interface value makes a copy of the
1073struct. If the interface value holds a pointer, copying the interface value
Oling Cat018e89f2013-01-24 20:46:33 +11001074makes a copy of the pointer, but again not the data it points to.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001075</p>
1076
Rob Pike09cd13c2013-03-15 11:38:50 -07001077<h3 id="pointer_to_interface">
1078When should I use a pointer to an interface?</h3>
1079
1080<p>
1081Almost never. Pointers to interface values arise only in rare, tricky situations involving
1082disguising an interface value's type for delayed evaluation.
1083</p>
1084
1085<p>
1086It is however a common mistake to pass a pointer to an interface value
1087to a function expecting an interface. The compiler will complain about this
1088error but the situation can still be confusing, because sometimes a
1089<a href="#different_method_sets">pointer
1090is necessary to satisfy an interface</a>.
1091The insight is that although a pointer to a concrete type can satisfy
Rob Pikea9422652014-10-26 11:27:55 -07001092an interface, with one exception <em>a pointer to an interface can never satisfy an interface</em>.
Rob Pike09cd13c2013-03-15 11:38:50 -07001093</p>
1094
1095<p>
1096Consider the variable declaration,
1097</p>
1098
1099<pre>
1100var w io.Writer
1101</pre>
1102
1103<p>
1104The printing function <code>fmt.Fprintf</code> takes as its first argument
1105a value that satisfies <code>io.Writer</code>—something that implements
1106the canonical <code>Write</code> method. Thus we can write
1107</p>
1108
1109<pre>
1110fmt.Fprintf(w, "hello, world\n")
1111</pre>
1112
1113<p>
1114If however we pass the address of <code>w</code>, the program will not compile.
1115</p>
1116
1117<pre>
1118fmt.Fprintf(&amp;w, "hello, world\n") // Compile-time error.
1119</pre>
1120
1121<p>
1122The one exception is that any value, even a pointer to an interface, can be assigned to
1123a variable of empty interface type (<code>interface{}</code>).
1124Even so, it's almost certainly a mistake if the value is a pointer to an interface;
1125the result can be confusing.
1126</p>
1127
Andrew Gerrand4164d602010-09-29 16:52:22 +10001128<h3 id="methods_on_values_or_pointers">
1129Should I define methods on values or pointers?</h3>
1130
1131<pre>
Rob Pike93c4a242011-08-06 07:41:55 +10001132func (s *MyStruct) pointerMethod() { } // method on pointer
1133func (s MyStruct) valueMethod() { } // method on value
Andrew Gerrand4164d602010-09-29 16:52:22 +10001134</pre>
Russ Cox32274452009-10-22 00:13:51 -07001135
1136<p>
Rob Pike93c4a242011-08-06 07:41:55 +10001137For programmers unaccustomed to pointers, the distinction between these
1138two examples can be confusing, but the situation is actually very simple.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001139When defining a method on a type, the receiver (<code>s</code> in the above
Rob Pike5cff1902012-02-20 12:42:50 +11001140examples) behaves exactly as if it were an argument to the method.
Rob Pike93c4a242011-08-06 07:41:55 +10001141Whether to define the receiver as a value or as a pointer is the same
1142question, then, as whether a function argument should be a value or
1143a pointer.
1144There are several considerations.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001145</p>
1146
Rob Pike93c4a242011-08-06 07:41:55 +10001147<p>
1148First, and most important, does the method need to modify the
1149receiver?
1150If it does, the receiver <em>must</em> be a pointer.
Rob Pike48ecfc92013-03-27 15:26:57 -07001151(Slices and maps act as references, so their story is a little
Rob Pike93c4a242011-08-06 07:41:55 +10001152more subtle, but for instance to change the length of a slice
1153in a method the receiver must still be a pointer.)
1154In the examples above, if <code>pointerMethod</code> modifies
1155the fields of <code>s</code>,
1156the caller will see those changes, but <code>valueMethod</code>
1157is called with a copy of the caller's argument (that's the definition
1158of passing a value), so changes it makes will be invisible to the caller.
1159</p>
1160
1161<p>
1162By the way, pointer receivers are identical to the situation in Java,
1163although in Java the pointers are hidden under the covers; it's Go's
1164value receivers that are unusual.
1165</p>
1166
1167<p>
1168Second is the consideration of efficiency. If the receiver is large,
1169a big <code>struct</code> for instance, it will be much cheaper to
1170use a pointer receiver.
1171</p>
1172
1173<p>
1174Next is consistency. If some of the methods of the type must have
1175pointer receivers, the rest should too, so the method set is
1176consistent regardless of how the type is used.
1177See the section on <a href="#different_method_sets">method sets</a>
1178for details.
1179</p>
1180
1181<p>
1182For types such as basic types, slices, and small <code>structs</code>,
1183a value receiver is very cheap so unless the semantics of the method
1184requires a pointer, a value receiver is efficient and clear.
1185</p>
1186
1187
Andrew Gerrand4164d602010-09-29 16:52:22 +10001188<h3 id="new_and_make">
1189What's the difference between new and make?</h3>
Russ Cox32274452009-10-22 00:13:51 -07001190
1191<p>
Andrew Gerrand4164d602010-09-29 16:52:22 +10001192In short: <code>new</code> allocates memory, <code>make</code> initializes
1193the slice, map, and channel types.
1194</p>
1195
1196<p>
1197See the <a href="/doc/effective_go.html#allocation_new">relevant section
1198of Effective Go</a> for more details.
1199</p>
1200
Andrew Gerrandaffd1ba2010-12-09 08:59:29 +11001201<h3 id="q_int_sizes">
Rob Pike48ecfc92013-03-27 15:26:57 -07001202What is the size of an <code>int</code> on a 64 bit machine?</h3>
Andrew Gerrand4164d602010-09-29 16:52:22 +10001203
1204<p>
Rob Pike80e25fc2011-01-19 23:07:38 -05001205The sizes of <code>int</code> and <code>uint</code> are implementation-specific
1206but the same as each other on a given platform.
Russ Cox10ea6512012-09-24 20:57:01 -04001207For portability, code that relies on a particular
Rob Pike80e25fc2011-01-19 23:07:38 -05001208size of value should use an explicitly sized type, like <code>int64</code>.
Russ Cox10ea6512012-09-24 20:57:01 -04001209Prior to Go 1.1, the 64-bit Go compilers (both gc and gccgo) used
1210a 32-bit representation for <code>int</code>. As of Go 1.1 they use
1211a 64-bit representation.
Rob Pike80e25fc2011-01-19 23:07:38 -05001212On the other hand, floating-point scalars and complex
1213numbers are always sized: <code>float32</code>, <code>complex64</code>,
1214etc., because programmers should be aware of precision when using
1215floating-point numbers.
1216The default size of a floating-point constant is <code>float64</code>.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001217</p>
1218
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001219<h3 id="stack_or_heap">
1220How do I know whether a variable is allocated on the heap or the stack?</h3>
1221
1222<p>
1223From a correctness standpoint, you don't need to know.
1224Each variable in Go exists as long as there are references to it.
1225The storage location chosen by the implementation is irrelevant to the
1226semantics of the language.
Evan Shaw64d85762011-05-22 14:56:12 +10001227</p>
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001228
1229<p>
1230The storage location does have an effect on writing efficient programs.
1231When possible, the Go compilers will allocate variables that are
1232local to a function in that function's stack frame. However, if the
1233compiler cannot prove that the variable is not referenced after the
1234function returns, then the compiler must allocate the variable on the
1235garbage-collected heap to avoid dangling pointer errors.
Rob Pikefcfed142012-01-23 08:39:53 -08001236Also, if a local variable is very large, it might make more sense
1237to store it on the heap rather than the stack.
Evan Shaw64d85762011-05-22 14:56:12 +10001238</p>
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001239
1240<p>
Rob Pike86494442011-11-08 16:26:03 -08001241In the current compilers, if a variable has its address taken, that variable
1242is a candidate for allocation on the heap. However, a basic <em>escape
1243analysis</em> recognizes some cases when such variables will not
1244live past the return from the function and can reside on the stack.
Evan Shaw64d85762011-05-22 14:56:12 +10001245</p>
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001246
Andrew Gerrand21009472012-10-11 14:21:19 +11001247<h3 id="Why_does_my_Go_process_use_so_much_virtual_memory">
1248Why does my Go process use so much virtual memory?</h3>
1249
1250<p>
1251The Go memory allocator reserves a large region of virtual memory as an arena
1252for allocations. This virtual memory is local to the specific Go process; the
1253reservation does not deprive other processes of memory.
1254</p>
1255
1256<p>
1257To find the amount of actual memory allocated to a Go process, use the Unix
1258<code>top</code> command and consult the <code>RES</code> (Linux) or
1259<code>RSIZE</code> (Mac OS X) columns.
1260<!-- TODO(adg): find out how this works on Windows -->
1261</p>
1262
Andrew Gerrand4164d602010-09-29 16:52:22 +10001263<h2 id="Concurrency">Concurrency</h2>
1264
1265<h3 id="What_operations_are_atomic_What_about_mutexes">
1266What operations are atomic? What about mutexes?</h3>
1267
1268<p>
1269We haven't fully defined it all yet, but some details about atomicity are
Andrew Gerrand48ba6fe2013-10-04 09:45:06 +10001270available in the <a href="/ref/mem">Go Memory Model specification</a>.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001271</p>
1272
1273<p>
1274Regarding mutexes, the <a href="/pkg/sync">sync</a>
1275package implements them, but we hope Go programming style will
1276encourage people to try higher-level techniques. In particular, consider
1277structuring your program so that only one goroutine at a time is ever
1278responsible for a particular piece of data.
1279</p>
1280
1281<p>
1282Do not communicate by sharing memory. Instead, share memory by communicating.
1283</p>
1284
Andrew Gerrand5ec55c52010-09-30 11:23:39 +10001285<p>
Andrew Gerrand43ad89d2014-07-25 10:28:39 +10001286See the <a href="/doc/codewalk/sharemem/">Share Memory By Communicating</a> code walk and its <a href="//blog.golang.org/2010/07/share-memory-by-communicating.html">associated article</a> for a detailed discussion of this concept.
Andrew Gerrand5ec55c52010-09-30 11:23:39 +10001287</p>
1288
Andrew Gerrand4164d602010-09-29 16:52:22 +10001289<h3 id="Why_no_multi_CPU">
1290Why doesn't my multi-goroutine program use multiple CPUs?</h3>
1291
1292<p>
Rob Pike5cff1902012-02-20 12:42:50 +11001293You must set the <code>GOMAXPROCS</code> shell environment variable
1294or use the similarly-named <a href="/pkg/runtime/#GOMAXPROCS"><code>function</code></a>
1295of the runtime package to allow the
Oling Cat018e89f2013-01-24 20:46:33 +11001296run-time support to utilize more than one OS thread.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001297</p>
1298
1299<p>
Rob Pike86494442011-11-08 16:26:03 -08001300Programs that perform parallel computation should benefit from an increase in
Rob Pike5cff1902012-02-20 12:42:50 +11001301<code>GOMAXPROCS</code>.
Rob Pike48ecfc92013-03-27 15:26:57 -07001302However, be aware that
Andrew Gerrand43ad89d2014-07-25 10:28:39 +10001303<a href="//blog.golang.org/2013/01/concurrency-is-not-parallelism.html">concurrency
Rob Pike48ecfc92013-03-27 15:26:57 -07001304is not parallelism</a>.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001305</p>
1306
1307<h3 id="Why_GOMAXPROCS">
1308Why does using <code>GOMAXPROCS</code> &gt; 1 sometimes make my program
1309slower?</h3>
1310
1311<p>
Oling Cat018e89f2013-01-24 20:46:33 +11001312It depends on the nature of your program.
Rob Pike01afb792012-01-26 14:44:38 -08001313Problems that are intrinsically sequential cannot be sped up by adding
1314more goroutines.
1315Concurrency only becomes parallelism when the problem is
1316intrinsically parallel.
1317</p>
1318
1319<p>
1320In practical terms, programs that spend more time
1321communicating on channels than doing computation
1322will experience performance degradation when using
1323multiple OS threads.
1324This is because sending data between threads involves switching
1325contexts, which has significant cost.
Andrew Gerrand48ba6fe2013-10-04 09:45:06 +10001326For instance, the <a href="/ref/spec#An_example_package">prime sieve example</a>
Rob Pike01afb792012-01-26 14:44:38 -08001327from the Go specification has no significant parallelism although it launches many
1328goroutines; increasing <code>GOMAXPROCS</code> is more likely to slow it down than
1329to speed it up.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001330</p>
1331
1332<p>
Rob Pikea9422652014-10-26 11:27:55 -07001333Go's goroutine scheduler is not as good as it needs to be. In the future, it
Rob Pike966bf712011-03-01 13:54:22 -08001334should recognize such cases and optimize its use of OS threads. For now,
Andrew Gerrand4164d602010-09-29 16:52:22 +10001335<code>GOMAXPROCS</code> should be set on a per-application basis.
1336</p>
1337
Rob Pike48ecfc92013-03-27 15:26:57 -07001338<p>
1339For more detail on this topic see the talk entitled,
Andrew Gerrand43ad89d2014-07-25 10:28:39 +10001340<a href="//blog.golang.org/2013/01/concurrency-is-not-parallelism.html">Concurrency
Rob Pike48ecfc92013-03-27 15:26:57 -07001341is not Parallelism</a>.
1342
Andrew Gerrand4164d602010-09-29 16:52:22 +10001343<h2 id="Functions_methods">Functions and Methods</h2>
1344
1345<h3 id="different_method_sets">
1346Why do T and *T have different method sets?</h3>
1347
1348<p>
Andrew Gerrand48ba6fe2013-10-04 09:45:06 +10001349From the <a href="/ref/spec#Types">Go Spec</a>:
Andrew Gerrand4164d602010-09-29 16:52:22 +10001350</p>
1351
1352<blockquote>
1353The method set of any other named type <code>T</code> consists of all methods
1354with receiver type <code>T</code>. The method set of the corresponding pointer
1355type <code>*T</code> is the set of all methods with receiver <code>*T</code> or
1356<code>T</code> (that is, it also contains the method set of <code>T</code>).
1357</blockquote>
1358
1359<p>
1360If an interface value contains a pointer <code>*T</code>,
1361a method call can obtain a value by dereferencing the pointer,
1362but if an interface value contains a value <code>T</code>,
1363there is no useful way for a method call to obtain a pointer.
1364</p>
1365
1366<p>
Rob Pike5cff1902012-02-20 12:42:50 +11001367Even in cases where the compiler could take the address of a value
1368to pass to the method, if the method modifies the value the changes
1369will be lost in the caller.
1370As a common example, this code:
Andrew Gerrand4164d602010-09-29 16:52:22 +10001371</p>
1372
1373<pre>
1374var buf bytes.Buffer
1375io.Copy(buf, os.Stdin)
1376</pre>
1377
1378<p>
1379would copy standard input into a <i>copy</i> of <code>buf</code>,
1380not into <code>buf</code> itself.
1381This is almost never the desired behavior.
1382</p>
1383
1384<h3 id="closures_and_goroutines">
Rob Pikefcfed142012-01-23 08:39:53 -08001385What happens with closures running as goroutines?</h3>
Andrew Gerrand4164d602010-09-29 16:52:22 +10001386
1387<p>
1388Some confusion may arise when using closures with concurrency.
1389Consider the following program:
1390</p>
1391
1392<pre>
1393func main() {
Rob Pikefcfed142012-01-23 08:39:53 -08001394 done := make(chan bool)
Andrew Gerrand4164d602010-09-29 16:52:22 +10001395
Rob Pike5cff1902012-02-20 12:42:50 +11001396 values := []string{"a", "b", "c"}
Rob Pikefcfed142012-01-23 08:39:53 -08001397 for _, v := range values {
1398 go func() {
1399 fmt.Println(v)
1400 done &lt;- true
1401 }()
1402 }
Andrew Gerrand4164d602010-09-29 16:52:22 +10001403
Rob Pikefcfed142012-01-23 08:39:53 -08001404 // wait for all goroutines to complete before exiting
1405 for _ = range values {
Oling Cat018e89f2013-01-24 20:46:33 +11001406 &lt;-done
Rob Pikefcfed142012-01-23 08:39:53 -08001407 }
Andrew Gerrand4164d602010-09-29 16:52:22 +10001408}
1409</pre>
1410
1411<p>
Oling Cat018e89f2013-01-24 20:46:33 +11001412One might mistakenly expect to see <code>a, b, c</code> as the output.
1413What you'll probably see instead is <code>c, c, c</code>. This is because
Rob Pikefcfed142012-01-23 08:39:53 -08001414each iteration of the loop uses the same instance of the variable <code>v</code>, so
Oling Cat018e89f2013-01-24 20:46:33 +11001415each closure shares that single variable. When the closure runs, it prints the
Rob Pikefcfed142012-01-23 08:39:53 -08001416value of <code>v</code> at the time <code>fmt.Println</code> is executed,
Oling Cat018e89f2013-01-24 20:46:33 +11001417but <code>v</code> may have been modified since the goroutine was launched.
Christian Himpel89ed40c2012-11-12 07:25:54 -08001418To help detect this and other problems before they happen, run
Dmitriy Vyukov2e1ddeb2014-05-07 18:49:13 +04001419<a href="/cmd/go/#hdr-Run_go_tool_vet_on_packages"><code>go vet</code></a>.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001420</p>
1421
1422<p>
Rob Pike0cab7d52012-09-07 09:11:39 -07001423To bind the current value of <code>v</code> to each closure as it is launched, one
1424must modify the inner loop to create a new variable each iteration.
1425One way is to pass the variable as an argument to the closure:
Andrew Gerrand4164d602010-09-29 16:52:22 +10001426</p>
1427
1428<pre>
Rob Pikefcfed142012-01-23 08:39:53 -08001429 for _, v := range values {
1430 go func(<b>u</b> string) {
1431 fmt.Println(<b>u</b>)
1432 done &lt;- true
1433 }(<b>v</b>)
1434 }
Andrew Gerrand4164d602010-09-29 16:52:22 +10001435</pre>
1436
1437<p>
Oling Cat018e89f2013-01-24 20:46:33 +11001438In this example, the value of <code>v</code> is passed as an argument to the
Andrew Gerrand4164d602010-09-29 16:52:22 +10001439anonymous function. That value is then accessible inside the function as
1440the variable <code>u</code>.
1441</p>
1442
Rob Pike0cab7d52012-09-07 09:11:39 -07001443<p>
1444Even easier is just to create a new variable, using a declaration style that may
1445seem odd but works fine in Go:
1446</p>
1447
1448<pre>
1449 for _, v := range values {
1450 <b>v := v</b> // create a new 'v'.
1451 go func() {
1452 fmt.Println(<b>v</b>)
1453 done &lt;- true
1454 }()
1455 }
1456</pre>
1457
Andrew Gerrand4164d602010-09-29 16:52:22 +10001458<h2 id="Control_flow">Control flow</h2>
1459
1460<h3 id="Does_Go_have_a_ternary_form">
1461Does Go have the <code>?:</code> operator?</h3>
1462
1463<p>
1464There is no ternary form in Go. You may use the following to achieve the same
1465result:
1466</p>
1467
1468<pre>
1469if expr {
Rob Pikefcfed142012-01-23 08:39:53 -08001470 n = trueVal
Andrew Gerrand4164d602010-09-29 16:52:22 +10001471} else {
Rob Pikefcfed142012-01-23 08:39:53 -08001472 n = falseVal
Andrew Gerrand4164d602010-09-29 16:52:22 +10001473}
1474</pre>
1475
1476<h2 id="Packages_Testing">Packages and Testing</h2>
1477
1478<h3 id="How_do_I_create_a_multifile_package">
1479How do I create a multifile package?</h3>
1480
1481<p>
1482Put all the source files for the package in a directory by themselves.
1483Source files can refer to items from different files at will; there is
1484no need for forward declarations or a header file.
1485</p>
1486
1487<p>
1488Other than being split into multiple files, the package will compile and test
1489just like a single-file package.
1490</p>
1491
1492<h3 id="How_do_I_write_a_unit_test">
1493How do I write a unit test?</h3>
1494
1495<p>
1496Create a new file ending in <code>_test.go</code> in the same directory
1497as your package sources. Inside that file, <code>import "testing"</code>
1498and write functions of the form
1499</p>
1500
1501<pre>
1502func TestFoo(t *testing.T) {
1503 ...
1504}
1505</pre>
1506
1507<p>
Rob Pike5cff1902012-02-20 12:42:50 +11001508Run <code>go test</code> in that directory.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001509That script finds the <code>Test</code> functions,
1510builds a test binary, and runs it.
1511</p>
1512
Rob Pike5cff1902012-02-20 12:42:50 +11001513<p>See the <a href="/doc/code.html">How to Write Go Code</a> document,
1514the <a href="/pkg/testing/"><code>testing</code></a> package
Andrew Gerrand399a36a2013-01-15 19:25:16 +11001515and the <a href="/cmd/go/#hdr-Test_packages"><code>go test</code></a> subcommand for more details.
Rob Pike5cff1902012-02-20 12:42:50 +11001516</p>
Andrew Gerrand5ec55c52010-09-30 11:23:39 +10001517
Rob Pikef6615f12011-11-09 13:19:23 -08001518<h3 id="testing_framework">
1519Where is my favorite helper function for testing?</h3>
1520
1521<p>
Rob Pike5cff1902012-02-20 12:42:50 +11001522Go's standard <a href="/pkg/testing/"><code>testing</code></a> package makes it easy to write unit tests, but it lacks
Rob Pikef6615f12011-11-09 13:19:23 -08001523features provided in other language's testing frameworks such as assertion functions.
1524An <a href="#assertions">earlier section</a> of this document explained why Go
1525doesn't have assertions, and
1526the same arguments apply to the use of <code>assert</code> in tests.
1527Proper error handling means letting other tests run after one has failed, so
1528that the person debugging the failure gets a complete picture of what is
1529wrong. It is more useful for a test to report that
1530<code>isPrime</code> gives the wrong answer for 2, 3, 5, and 7 (or for
15312, 4, 8, and 16) than to report that <code>isPrime</code> gives the wrong
1532answer for 2 and therefore no more tests were run. The programmer who
1533triggers the test failure may not be familiar with the code that fails.
1534Time invested writing a good error message now pays off later when the
1535test breaks.
1536</p>
1537
1538<p>
1539A related point is that testing frameworks tend to develop into mini-languages
1540of their own, with conditionals and controls and printing mechanisms,
1541but Go already has all those capabilities; why recreate them?
1542We'd rather write tests in Go; it's one fewer language to learn and the
1543approach keeps the tests straightforward and easy to understand.
1544</p>
1545
1546<p>
1547If the amount of extra code required to write
1548good errors seems repetitive and overwhelming, the test might work better if
1549table-driven, iterating over a list of inputs and outputs defined
1550in a data structure (Go has excellent support for data structure literals).
1551The work to write a good test and good error messages will then be amortized over many
1552test cases. The standard Go library is full of illustrative examples, such as in
Russ Cox220a6de2014-09-08 00:06:45 -04001553<a href="/src/fmt/fmt_test.go">the formatting tests for the <code>fmt</code> package</a>.
Rob Pikef6615f12011-11-09 13:19:23 -08001554</p>
1555
Russ Cox32274452009-10-22 00:13:51 -07001556
1557<h2 id="Implementation">Implementation</h2>
1558
1559<h3 id="What_compiler_technology_is_used_to_build_the_compilers">
1560What compiler technology is used to build the compilers?</h3>
1561
1562<p>
Mike Rossetb4afe882013-03-12 17:12:56 -07001563<code>Gccgo</code> has a front end written in C++, with a recursive descent parser coupled to the
Rob Pike0c2a4792009-11-01 20:50:42 -08001564standard GCC back end. <code>Gc</code> is written in C using
1565<code>yacc</code>/<code>bison</code> for the parser.
Russ Cox32274452009-10-22 00:13:51 -07001566Although it's a new program, it fits in the Plan 9 C compiler suite
1567(<a href="http://plan9.bell-labs.com/sys/doc/compiler.html">http://plan9.bell-labs.com/sys/doc/compiler.html</a>)
Shenghou Mac3eaef72012-03-17 15:53:40 +08001568and uses a variant of the Plan 9 loader to generate ELF/Mach-O/PE binaries.
Evan Shaw64d85762011-05-22 14:56:12 +10001569</p>
Russ Cox32274452009-10-22 00:13:51 -07001570
1571<p>
Rob Pike56c4d0a2014-09-27 11:56:54 -07001572We considered using LLVM for <code>gc</code> but we felt it was too large and
1573slow to meet our performance goals.
Evan Shaw64d85762011-05-22 14:56:12 +10001574</p>
Russ Cox32274452009-10-22 00:13:51 -07001575
1576<p>
Rob Pike56c4d0a2014-09-27 11:56:54 -07001577We also considered writing <code>gc</code>, the original Go compiler, in Go itself but
1578elected not to do so because of the difficulties of bootstrapping and
1579especially of open source distribution&mdash;you'd need a Go compiler to
1580set up a Go environment. <code>Gccgo</code>, which came later, makes it possible to
1581consider writing a compiler in Go.
1582A plan to do that by machine translation of the existing compiler is under development.
1583<a href="http://golang.org/s/go13compiler">A separate document</a>
1584explains the reason for this approach.
1585</p>
1586
1587<p>
1588That plan aside,
1589Go is a
1590fine language in which to implement a self-hosting compiler: a native lexer and
1591parser are already available in the <a href="/pkg/go/"><code>go</code></a> package
1592and a separate type checking
Andrew Gerrand7f0be1f2014-11-10 09:15:57 +11001593<a href="http://godoc.org/golang.org/x/tools/go/types">package</a>
Rob Pike56c4d0a2014-09-27 11:56:54 -07001594has also been written.
Evan Shaw64d85762011-05-22 14:56:12 +10001595</p>
Russ Cox32274452009-10-22 00:13:51 -07001596
Rob Pike966bf712011-03-01 13:54:22 -08001597<h3 id="How_is_the_run_time_support_implemented">
1598How is the run-time support implemented?</h3>
Russ Cox32274452009-10-22 00:13:51 -07001599
1600<p>
Rob Pike56c4d0a2014-09-27 11:56:54 -07001601Again due to bootstrapping issues, the run-time code was originally written mostly in C (with a
1602tiny bit of assembler) although much of it has been translated to Go since then
1603and one day all of it might be (except for the assembler bits).
1604<code>Gccgo</code>'s run-time support uses <code>glibc</code>.
1605<code>Gc</code> uses a custom C library to keep the footprint under
Rob Pike0c2a4792009-11-01 20:50:42 -08001606control; it is
1607compiled with a version of the Plan 9 C compiler that supports
Rob Pike287967f2014-03-21 13:59:30 +11001608resizable stacks for goroutines.
1609The <code>gccgo</code> compiler implements these on Linux only,
1610using a technique called segmented stacks,
1611supported by recent modifications to the gold linker.
Evan Shaw64d85762011-05-22 14:56:12 +10001612</p>
Andrew Gerrand08575732010-04-21 14:00:56 +10001613
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001614<h3 id="Why_is_my_trivial_program_such_a_large_binary">
1615Why is my trivial program such a large binary?</h3>
1616
1617<p>
Rob Pike86494442011-11-08 16:26:03 -08001618The linkers in the gc tool chain (<code>5l</code>, <code>6l</code>, and <code>8l</code>)
1619do static linking. All Go binaries therefore include the Go
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001620run-time, along with the run-time type information necessary to support dynamic
1621type checks, reflection, and even panic-time stack traces.
Evan Shaw64d85762011-05-22 14:56:12 +10001622</p>
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001623
1624<p>
Rob Pike0130a312012-03-07 15:29:26 +11001625A simple C "hello, world" program compiled and linked statically using gcc
1626on Linux is around 750 kB,
1627including an implementation of <code>printf</code>.
1628An equivalent Go program using <code>fmt.Printf</code>
Rob Pike56c4d0a2014-09-27 11:56:54 -07001629is around 1.9 MB, but
1630that includes more powerful run-time support and type information.
Evan Shaw64d85762011-05-22 14:56:12 +10001631</p>
Andrew Gerrand4b0ecd32011-03-01 21:35:46 +11001632
Rob Pike7d87f3d2011-08-06 11:21:59 +10001633<h3 id="unused_variables_and_imports">
1634Can I stop these complaints about my unused variable/import?</h3>
1635
1636<p>
1637The presence of an unused variable may indicate a bug, while
Rob Pikedba2faf2014-10-01 15:25:56 -07001638unused imports just slow down compilation,
1639an effect that can become substantial as a program accumulates
1640code and programmers over time.
1641For these reasons, Go refuses to compile programs with unused
1642variables or imports,
1643trading short-term convenience for long-term build speed and
1644program clarity.
Rob Pike7d87f3d2011-08-06 11:21:59 +10001645</p>
1646
1647<p>
Rob Pikedba2faf2014-10-01 15:25:56 -07001648Still, when developing code, it's common to create these situations
Rob Pike7d87f3d2011-08-06 11:21:59 +10001649temporarily and it can be annoying to have to edit them out before the
Oling Cat018e89f2013-01-24 20:46:33 +11001650program will compile.
Rob Pike7d87f3d2011-08-06 11:21:59 +10001651</p>
1652
1653<p>
1654Some have asked for a compiler option to turn those checks off
1655or at least reduce them to warnings.
1656Such an option has not been added, though,
1657because compiler options should not affect the semantics of the
1658language and because the Go compiler does not report warnings, only
1659errors that prevent compilation.
1660</p>
1661
1662<p>
1663There are two reasons for having no warnings. First, if it's worth
1664complaining about, it's worth fixing in the code. (And if it's not
1665worth fixing, it's not worth mentioning.) Second, having the compiler
1666generate warnings encourages the implementation to warn about weak
1667cases that can make compilation noisy, masking real errors that
1668<em>should</em> be fixed.
1669</p>
1670
1671<p>
1672It's easy to address the situation, though. Use the blank identifier
1673to let unused things persist while you're developing.
1674</p>
1675
1676<pre>
1677import "unused"
1678
1679// This declaration marks the import as used by referencing an
1680// item from the package.
1681var _ = unused.Item // TODO: Delete before committing!
1682
1683func main() {
Rob Pikefcfed142012-01-23 08:39:53 -08001684 debugData := debug.Profile()
1685 _ = debugData // Used only during debugging.
1686 ....
Rob Pike7d87f3d2011-08-06 11:21:59 +10001687}
1688</pre>
1689
Rob Pike56c4d0a2014-09-27 11:56:54 -07001690<p>
1691Nowadays, most Go programmers use a tool,
Andrew Gerrand7f0be1f2014-11-10 09:15:57 +11001692<a href="http://godoc.org/golang.org/x/tools/cmd/goimports">goimports</a>,
Rob Pike56c4d0a2014-09-27 11:56:54 -07001693which automatically rewrites a Go source file to have the correct imports,
1694eliminating the unused imports issue in practice.
1695This program is easily connected to most editors to run automatically when a Go source file is written.
1696</p>
1697
Andrew Gerrand08575732010-04-21 14:00:56 +10001698<h2 id="Performance">Performance</h2>
1699
1700<h3 id="Why_does_Go_perform_badly_on_benchmark_x">
1701Why does Go perform badly on benchmark X?</h3>
1702
1703<p>
1704One of Go's design goals is to approach the performance of C for comparable
Oling Cat018e89f2013-01-24 20:46:33 +11001705programs, yet on some benchmarks it does quite poorly, including several
1706in <a href="/test/bench/shootout/">test/bench/shootout</a>. The slowest depend on libraries
1707for which versions of comparable performance are not available in Go.
Rob Pikefcfed142012-01-23 08:39:53 -08001708For instance, <a href="/test/bench/shootout/pidigits.go">pidigits.go</a>
1709depends on a multi-precision math package, and the C
Andrew Gerrand08575732010-04-21 14:00:56 +10001710versions, unlike Go's, use <a href="http://gmplib.org/">GMP</a> (which is
Oling Cat018e89f2013-01-24 20:46:33 +11001711written in optimized assembler).
Rob Pikefcfed142012-01-23 08:39:53 -08001712Benchmarks that depend on regular expressions
1713(<a href="/test/bench/shootout/regex-dna.go">regex-dna.go</a>, for instance) are
Rob Pike86494442011-11-08 16:26:03 -08001714essentially comparing Go's native <a href="/pkg/regexp">regexp package</a> to
Andrew Gerrand08575732010-04-21 14:00:56 +10001715mature, highly optimized regular expression libraries like PCRE.
1716</p>
1717
1718<p>
1719Benchmark games are won by extensive tuning and the Go versions of most
1720of the benchmarks need attention. If you measure comparable C
Rob Pikefcfed142012-01-23 08:39:53 -08001721and Go programs
1722(<a href="/test/bench/shootout/reverse-complement.go">reverse-complement.go</a> is one example), you'll see the two
Andrew Gerrand08575732010-04-21 14:00:56 +10001723languages are much closer in raw performance than this suite would
1724indicate.
1725</p>
1726
1727<p>
1728Still, there is room for improvement. The compilers are good but could be
Andrew Gerrand05427742010-04-23 10:02:10 +10001729better, many libraries need major performance work, and the garbage collector
Oling Cat018e89f2013-01-24 20:46:33 +11001730isn't fast enough yet. (Even if it were, taking care not to generate unnecessary
Rob Pikefcfed142012-01-23 08:39:53 -08001731garbage can have a huge effect.)
Andrew Gerrand08575732010-04-21 14:00:56 +10001732</p>
1733
Rob Pike93c4a242011-08-06 07:41:55 +10001734<p>
Rob Pike5cff1902012-02-20 12:42:50 +11001735In any case, Go can often be very competitive.
1736There has been significant improvement in the performance of many programs
1737as the language and tools have developed.
1738See the blog post about
Andrew Gerrand43ad89d2014-07-25 10:28:39 +10001739<a href="//blog.golang.org/2011/06/profiling-go-programs.html">profiling
Rob Pike93c4a242011-08-06 07:41:55 +10001740Go programs</a> for an informative example.
1741
Andrew Gerrand4164d602010-09-29 16:52:22 +10001742<h2 id="change_from_c">Changes from C</h2>
1743
1744<h3 id="different_syntax">
1745Why is the syntax so different from C?</h3>
1746<p>
1747Other than declaration syntax, the differences are not major and stem
1748from two desires. First, the syntax should feel light, without too
1749many mandatory keywords, repetition, or arcana. Second, the language
1750has been designed to be easy to analyze
1751and can be parsed without a symbol table. This makes it much easier
1752to build tools such as debuggers, dependency analyzers, automated
1753documentation extractors, IDE plug-ins, and so on. C and its
1754descendants are notoriously difficult in this regard.
1755</p>
1756
1757<h3 id="declarations_backwards">
1758Why are declarations backwards?</h3>
1759<p>
1760They're only backwards if you're used to C. In C, the notion is that a
1761variable is declared like an expression denoting its type, which is a
1762nice idea, but the type and expression grammars don't mix very well and
1763the results can be confusing; consider function pointers. Go mostly
1764separates expression and type syntax and that simplifies things (using
1765prefix <code>*</code> for pointers is an exception that proves the rule). In C,
1766the declaration
1767</p>
1768<pre>
Rob Pikefcfed142012-01-23 08:39:53 -08001769 int* a, b;
Andrew Gerrand4164d602010-09-29 16:52:22 +10001770</pre>
1771<p>
1772declares <code>a</code> to be a pointer but not <code>b</code>; in Go
1773</p>
1774<pre>
Rob Pikefcfed142012-01-23 08:39:53 -08001775 var a, b *int
Andrew Gerrand4164d602010-09-29 16:52:22 +10001776</pre>
1777<p>
1778declares both to be pointers. This is clearer and more regular.
1779Also, the <code>:=</code> short declaration form argues that a full variable
1780declaration should present the same order as <code>:=</code> so
1781</p>
1782<pre>
Rob Pikefcfed142012-01-23 08:39:53 -08001783 var a uint64 = 1
Andrew Gerrand4164d602010-09-29 16:52:22 +10001784</pre>
Stefan Nilssonc50074e2012-02-29 15:07:52 -08001785<p>
Andrew Gerrand4164d602010-09-29 16:52:22 +10001786has the same effect as
Stefan Nilssonc50074e2012-02-29 15:07:52 -08001787</p>
Andrew Gerrand4164d602010-09-29 16:52:22 +10001788<pre>
Rob Pikefcfed142012-01-23 08:39:53 -08001789 a := uint64(1)
Andrew Gerrand4164d602010-09-29 16:52:22 +10001790</pre>
1791<p>
1792Parsing is also simplified by having a distinct grammar for types that
1793is not just the expression grammar; keywords such as <code>func</code>
1794and <code>chan</code> keep things clear.
1795</p>
1796
Andrew Gerrand5ec55c52010-09-30 11:23:39 +10001797<p>
Rob Pike93c4a242011-08-06 07:41:55 +10001798See the article about
Francisco Souza6033a482012-03-13 14:46:08 +11001799<a href="/doc/articles/gos_declaration_syntax.html">Go's Declaration Syntax</a>
Rob Pike93c4a242011-08-06 07:41:55 +10001800for more details.
Andrew Gerrand5ec55c52010-09-30 11:23:39 +10001801</p>
1802
Andrew Gerrand4164d602010-09-29 16:52:22 +10001803<h3 id="no_pointer_arithmetic">
1804Why is there no pointer arithmetic?</h3>
1805<p>
1806Safety. Without pointer arithmetic it's possible to create a
1807language that can never derive an illegal address that succeeds
1808incorrectly. Compiler and hardware technology have advanced to the
1809point where a loop using array indices can be as efficient as a loop
1810using pointer arithmetic. Also, the lack of pointer arithmetic can
1811simplify the implementation of the garbage collector.
1812</p>
1813
1814<h3 id="inc_dec">
1815Why are <code>++</code> and <code>--</code> statements and not expressions? And why postfix, not prefix?</h3>
1816<p>
1817Without pointer arithmetic, the convenience value of pre- and postfix
1818increment operators drops. By removing them from the expression
1819hierarchy altogether, expression syntax is simplified and the messy
1820issues around order of evaluation of <code>++</code> and <code>--</code>
1821(consider <code>f(i++)</code> and <code>p[i] = q[++i]</code>)
1822are eliminated as well. The simplification is
1823significant. As for postfix vs. prefix, either would work fine but
1824the postfix version is more traditional; insistence on prefix arose
1825with the STL, a library for a language whose name contains, ironically, a
1826postfix increment.
1827</p>
1828
1829<h3 id="semicolons">
1830Why are there braces but no semicolons? And why can't I put the opening
1831brace on the next line?</h3>
1832<p>
1833Go uses brace brackets for statement grouping, a syntax familiar to
1834programmers who have worked with any language in the C family.
1835Semicolons, however, are for parsers, not for people, and we wanted to
1836eliminate them as much as possible. To achieve this goal, Go borrows
1837a trick from BCPL: the semicolons that separate statements are in the
1838formal grammar but are injected automatically, without lookahead, by
1839the lexer at the end of any line that could be the end of a statement.
1840This works very well in practice but has the effect that it forces a
1841brace style. For instance, the opening brace of a function cannot
1842appear on a line by itself.
1843</p>
Evan Shaw64d85762011-05-22 14:56:12 +10001844
Andrew Gerrand4164d602010-09-29 16:52:22 +10001845<p>
1846Some have argued that the lexer should do lookahead to permit the
1847brace to live on the next line. We disagree. Since Go code is meant
1848to be formatted automatically by
Shenghou Ma97b13ac2012-03-07 08:15:47 +11001849<a href="/cmd/gofmt/"><code>gofmt</code></a>,
Andrew Gerrand4164d602010-09-29 16:52:22 +10001850<i>some</i> style must be chosen. That style may differ from what
1851you've used in C or Java, but Go is a new language and
1852<code>gofmt</code>'s style is as good as any other. More
1853important&mdash;much more important&mdash;the advantages of a single,
1854programmatically mandated format for all Go programs greatly outweigh
1855any perceived disadvantages of the particular style.
1856Note too that Go's style means that an interactive implementation of
1857Go can use the standard syntax one line at a time without special rules.
1858</p>
1859
1860<h3 id="garbage_collection">
1861Why do garbage collection? Won't it be too expensive?</h3>
1862<p>
1863One of the biggest sources of bookkeeping in systems programs is
1864memory management. We feel it's critical to eliminate that
1865programmer overhead, and advances in garbage collection
1866technology in the last few years give us confidence that we can
1867implement it with low enough overhead and no significant
Rob Pikefcfed142012-01-23 08:39:53 -08001868latency.
Andrew Gerrand4164d602010-09-29 16:52:22 +10001869</p>
Evan Shaw64d85762011-05-22 14:56:12 +10001870
Andrew Gerrand4164d602010-09-29 16:52:22 +10001871<p>
1872Another point is that a large part of the difficulty of concurrent
1873and multi-threaded programming is memory management;
1874as objects get passed among threads it becomes cumbersome
1875to guarantee they become freed safely.
1876Automatic garbage collection makes concurrent code far easier to write.
1877Of course, implementing garbage collection in a concurrent environment is
1878itself a challenge, but meeting it once rather than in every
1879program helps everyone.
1880</p>
Evan Shaw64d85762011-05-22 14:56:12 +10001881
Andrew Gerrand4164d602010-09-29 16:52:22 +10001882<p>
1883Finally, concurrency aside, garbage collection makes interfaces
1884simpler because they don't need to specify how memory is managed across them.
1885</p>
Rob Pike93c4a242011-08-06 07:41:55 +10001886
1887<p>
Rob Pikefcfed142012-01-23 08:39:53 -08001888The current implementation is a parallel mark-and-sweep
1889collector but a future version might take a different approach.
1890</p>
1891
1892<p>
Rob Pike93c4a242011-08-06 07:41:55 +10001893On the topic of performance, keep in mind that Go gives the programmer
1894considerable control over memory layout and allocation, much more than
1895is typical in garbage-collected languages. A careful programmer can reduce
1896the garbage collection overhead dramatically by using the language well;
1897see the article about
Andrew Gerrand43ad89d2014-07-25 10:28:39 +10001898<a href="//blog.golang.org/2011/06/profiling-go-programs.html">profiling
Rob Pike93c4a242011-08-06 07:41:55 +10001899Go programs</a> for a worked example, including a demonstration of Go's
1900profiling tools.
1901</p>