Commit Graph

1754 Commits

Author SHA1 Message Date
Jordan Rose
70bda7c5db [docs] LibraryEvolution: This is about binary compatibility.
...and can't guarantee semantic compatibility. Make this clear in the
introduction, as noted by David Owens.
2016-02-18 15:33:59 -08:00
Jordan Rose
ef2474056b Merge pull request #1340 from practicalswift/remove-spaces-from-filenames
[gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst")
2016-02-18 09:44:32 -08:00
Joe Groff
ae0e855aaf Revert "Runtime: Remove retainCount entry points."
This reverts commit 51e0594e1c. The retainCount
entry points are used by Instruments.
2016-02-18 09:38:23 -08:00
practicalswift
5d24d87d81 [gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst")
Fix some cases where "Camel Case.rst" is used instead of "CamelCase.rst".

File counts:
* Files in repo: 10 242
* Files in repo with spaces in file name: 10
* Files in repo with .rst suffix: 74
* Files in repo with .rst suffix and spaces in file name: 10

In addition to the consistency argument: spaces in file names create unnecessary
gotchas when it comes to bash scripting - see below.

Before this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
ls: cannot access ./docs/Dependency: No such file or directory
ls: cannot access Analysis.rst: No such file or directory
ls: cannot access ./docs/proposals/ObjC: No such file or directory
ls: cannot access Interoperation.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Argument: No such file or directory
ls: cannot access Interop.rst: No such file or directory
ls: cannot access ./docs/proposals/archive/Memory: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Concurrency: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Interop: No such file or directory
ls: cannot access Language: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/rejected/Bridging: No such file or directory
ls: cannot access Container: No such file or directory
ls: cannot access Protocols: No such file or directory
ls: cannot access to: No such file or directory
ls: cannot access Class: No such file or directory
ls: cannot access Clusters.rst: No such file or directory
ls: cannot access ./docs/archive/Namespace: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Vars: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Top: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Code.rst: No such file or directory
ls: cannot access ./docs/archive/Objective-C: No such file or directory
ls: cannot access Interoperability.rst: No such file or directory
ls: cannot access ./docs/Pattern: No such file or directory
ls: cannot access Matching.rst: No such file or directory
ls: cannot access ./docs/Failable: No such file or directory
ls: cannot access Initializers.rst: No such file or directory
$
```

After this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
$
```
2016-02-18 10:46:53 +01:00
John McCall
e249fd680e Destructure result types in SIL function types.
Similarly to how we've always handled parameter types, we
now recursively expand tuples in result types and separately
determine a result convention for each result.

The most important code-generation change here is that
indirect results are now returned separately from each
other and from any direct results.  It is generally far
better, when receiving an indirect result, to receive it
as an independent result; the caller is much more likely
to be able to directly receive the result in the address
they want to initialize, rather than having to receive it
in temporary memory and then copy parts of it into the
target.

The most important conceptual change here that clients and
producers of SIL must be aware of is the new distinction
between a SILFunctionType's *parameters* and its *argument
list*.  The former is just the formal parameters, derived
purely from the parameter types of the original function;
indirect results are no longer in this list.  The latter
includes the indirect result arguments; as always, all
the indirect results strictly precede the parameters.
Apply instructions and entry block arguments follow the
argument list, not the parameter list.

A relatively minor change is that there can now be multiple
direct results, each with its own result convention.
This is a minor change because I've chosen to leave
return instructions as taking a single operand and
apply instructions as producing a single result; when
the type describes multiple results, they are implicitly
bound up in a tuple.  It might make sense to split these
up and allow e.g. return instructions to take a list
of operands; however, it's not clear what to do on the
caller side, and this would be a major change that can
be separated out from this already over-large patch.

Unsurprisingly, the most invasive changes here are in
SILGen; this requires substantial reworking of both call
emission and reabstraction.  It also proved important
to switch several SILGen operations over to work with
RValue instead of ManagedValue, since otherwise they
would be forced to spuriously "implode" buffers.
2016-02-18 01:26:28 -08:00
Jordan Rose
11ff7157ff [docs] LibraryEvolution: Dmitri's feedback for @always_emit_into_client.
The main change is that @always_emit_into_client is now not considered a
versioned attribute: either you use it up front and the entity is not part
of your ABI, or you don't and it is. Everything else falls out from that.
2016-02-16 12:10:59 -08:00
practicalswift
6b8d231575 [gardening] Fix recently introduced typo: "an function" → "a function" 2016-02-16 09:53:07 +01:00
Jordan Rose
b39cebd6fc [docs] LibraryEvolution: @always_emit_into_client
Describe a new attribute, @always_emit_into_client, which covers the
behavior of helpers for inlineable functions: any client that makes use
of the body of an inlineable function should use that implementation,
including any helper functions, local functions, or closures referenced
therein. This is also a tool a library developer can use.

This is a nice change because it formalizes several things that were
previously special-cased; however, there are still some open questions.

It's not totally clear whether we want separate @inlineable and
@always_emit_into_client annotations; we could attempt to get away with
just the latter. However, as noted in the diff, there are some entities
that can't really be completely eliminated from the ABI, so marking them
@always_emit_into_client would be disingenuous.
2016-02-15 19:17:16 -08:00
Dmitri Gribenko
226ab38888 CMake / lit: add a mode to run only executable tests
This allows us to quickly run tests affected by implementation-only
standard library changes.
2016-02-12 22:50:42 -08:00
Jordan Rose
9c37cb6a7b [Sphinx] Fix the copyright year to always be the current year.
This is what we were doing manually anyway.
2016-02-12 18:43:15 -08:00
Jordan Rose
a5ce1391bd [docs] LibraryEvolution: Address smaller feedback points.
...from JoeG, Dmitri, and David Owens.

- Add an explicit section on default arguments.
- Replace the phrase "permitted but discouraged" with a new and stronger
  term "binary-compatible source-breaking change". This may need more
  work but it is an improvement.
- Mark that we could make converting get-only 'var' to 'let' safe.
- Adding a required convenience init is safe with certain restrictions.
- Add some more related proposals.
- Add a todo list for more substantive changes and ongoing discussion.
- Assorted clarifications and typo fixes.
2016-02-12 18:30:03 -08:00
Mark Lacey
bd30572f80 Minor clean-up of -assert-config option handling.
* Replace 'Fast' with 'Unchecked' everywhere.
* Update the help text to specify DisableReplacement rather than
  Replacement and to document Unchecked.
* Simplify tests slightly and add a tests for Unchecked.
2016-02-12 15:10:45 -08:00
practicalswift
383b6b746e [gardening] Fix recently introduced typo: "overrideable" → "overridable" 2016-02-09 22:46:12 +01:00
Prayag Verma
0f3c384c72 Fix a typo
Remove extra `to`
2016-02-09 20:05:48 +05:30
Jordan Rose
b0f94ed4b7 [docs] LibraryEvolution: Make code snippets more concrete, take 2.
Missed a spot.
2016-02-08 17:21:15 -08:00
Jordan Rose
3737ce7beb [docs] LibraryEvolution: Make code snippets more concrete.
...by giving all the types silly magic-themed names, rather than just
'Base' or 'SomeProto'. That makes a (mostly) consistent theme throughout
the document, and hopefully makes it easier to have a mental model
about what various changes mean.
2016-02-08 17:20:28 -08:00
Jordan Rose
d58b14db70 [docs] LibraryEvolution: Remove the "draft" warning.
Not that it won't continue to change, but it's moving from "we're
working things out" to "basically the plan of record". Time to ask for
feedback!
2016-02-08 16:59:10 -08:00
Jordan Rose
2c1e329233 [docs] LibraryEvolution: Add some known problematic scenarios.
These are pretty sketchy, but they do cause issues.
2016-02-08 16:27:54 -08:00
Jordan Rose
0db4f95527 [docs] LibraryEvolution: Allow adding associated types.
We're going to try to do this.
2016-02-08 16:27:54 -08:00
Jordan Rose
0be8afe114 [docs] LibraryEvolution: Assorted edits.
Filling out some sections, wordsmithing others, moving things around.
2016-02-07 10:12:50 -08:00
Jordan Rose
dc04ebf9b1 [docs] LibraryEvolution: Backdating rules don't apply to SPI.
...if we had such a feature, anyway.
2016-02-07 10:12:50 -08:00
Jordan Rose
a53ebe7681 [docs] LibraryEvolution: Initializers need to enforce DI.
...so they usually can't be inlineable. Explain which ones can and which
ones can't.
2016-02-07 10:12:50 -08:00
Jordan Rose
005b6eba79 [docs] LibraryEvolution: Add a section on backdating. 2016-02-07 10:12:49 -08:00
practicalswift
7127018255 [gardening] Fix recently introduced typo: "overrideable" → "overridable" 2016-02-06 10:41:13 +01:00
Slava Pestov
bbbe307980 SIL: Introduce SILDefaultWitnessTable and start plumbing
This will be used to help IRGen record protocol requirements
with resilient default implementations in protocol metadata.

To enable testing before all the Sema support is in place, this
patch adds SIL parser, printer and verifier support for default
witness tables.

For now, SILGen emits empty default witness tables for protocol
declarations in resilient modules, and IRGen ignores them when
emitting protocol metadata.
2016-02-05 20:57:11 -08:00
Jordan Rose
6e4599ca01 [docs] LibraryEvolution: Discuss nominal members explicitly.
I realized "members are mostly the same as their top-level equivalents" is worth
calling out explicitly, especially for subscripts and initializers without top-level
equivalents. There's still a hole here for members of protocol extensions, which can
have pretty drastic effects on conforming types.
2016-02-05 20:48:15 -08:00
Jordan Rose
d0ccc987af [docs] LibraryEvolution: Add a discussion of deployments.
I could explain that here, but it's all in the new section. :-)
2016-02-05 18:19:33 -08:00
Jordan Rose
33756a53b2 [docs] LibraryEvolution: s/proposal/document/
"Proposal" refers to something going through the Swift Evolution Process,
which this won't as such. (Although it does have many pieces affected by
proposals, as described at the end of the document.)
2016-02-05 16:35:13 -08:00
Jordan Rose
a062186d5e [docs] LibraryEvolution: Fill out the section on fixed-contents classes.
Basically, elaborate on why it's not important right now. Also, drop the
section on limiting the addition of new vtable-dispatched methods. That's
not something we're really interested in.
2016-02-05 16:35:13 -08:00
Jordan Rose
cb87705fe4 [docs] LibraryEvolution: Point out a Central Tenet of Swift:
The Default Behavior Should Be Safe

Also, remove the line about "providing tools to check changes", because
it no longer fits in the prologue flow and isn't core to the model.
The section on it is good enough.
2016-02-05 11:54:35 -08:00
Dmitri Gribenko
27be1ab257 build-script: allow to run host-side iOS tests
This change allows to easily run iOS tests that require only running the
compiler, and don't require running the generated code.
2016-02-04 17:19:12 -08:00
Jordan Rose
65155cba0d [docs] LibraryEvolution: Member typealiases affect ABI.
Thanks, Dmitri!
2016-02-04 13:41:24 -08:00
Dmitri Gribenko
c62dde514b Merge pull request #1198 from practicalswift/typo-fixes-20160204
[gardening] Fix recently introduced typos: "overrideable" → "overridable", "additioned" → "addition"
2016-02-04 09:16:04 -08:00
practicalswift
59737e4781 [gardening] Fix recently introduced typo: "additioned" → "addition" 2016-02-04 12:56:52 +01:00
practicalswift
c53bd4d3cb [gardening] Fix recently introduced typo: "overrideable" → "overridable" 2016-02-04 12:05:35 +01:00
Jordan Rose
10f2c9ac5a [docs] LibraryEvolution: Add a section on minimum library versions. 2016-02-03 19:08:51 -08:00
Jordan Rose
9af119d9ce [docs] LibraryEvolution: Add information about attributes.
I went through the list of attributes and declaration modifiers and
made sure they were all accounted for. Anything not on the list
should be assumed restricted, as mentioned at the top of the
"Supported Evolution" section.
2016-02-03 17:14:39 -08:00
Jordan Rose
e01d29b170 [docs] LibraryEvolution: Add missing related proposal.
"Overridable methods in extensions"
2016-02-03 17:14:39 -08:00
David Farler
a6a5ece206 IRGen: Emit type references for remote reflection
- Implement emission of type references for nominal type field
  reflection, using a small custom encoder resulting in packed
  structs, not strings. This will let us embed 7-bit encoded
  32-bit relative offsets directly in the structure (not yet
  hooked in).
- Use the AST Mangler for encoding type references
  Archetypes and internal references were complicating this before, so we
  can take the opportunity to reuse this machinery and avoid unique code
  and new ABI.

Next up: Tests for reading the reflection sections and converting the
demangle tree into a tree of type references.

Todo: For concrete types, serialize the types for associated types of
their conformances to bootstrap the typeref substitution process.

rdar://problem/15617914
2016-02-03 13:52:26 -08:00
Jordan Rose
a83089bce3 [docs] LibraryEvolution: List out related proposals.
...most of which don't exist yet. These are things that need to go
through the Swift Evolution Process and ultimately be accepted or
rejected before we have final answers on some parts of the document.
2016-02-02 18:20:29 -08:00
Ted Kremenek
af3f8ec990 Merge pull request #173 from DaKnOb/image-optim
Optimize Documentation Images to Save Bandwidth
2016-02-02 18:17:42 -08:00
Jordan Rose
b9ef11e703 [docs] LibraryEvolution: Typealiases are compile-time constructs.
...and therefore unversioned.
2016-02-02 17:41:29 -08:00
Jordan Rose
ef62e38726 [docs] LibraryEvolution: Keep a list item together with a note.
The third item was added to this list without looking at the note.
2016-02-02 17:41:29 -08:00
Jordan Rose
7df2f13d00 [docs] LibraryEvolution: Resolve several TODOs by fiat.
The heuristic here is mostly "err on the side of a simpler document".
2016-02-01 15:04:20 -08:00
Doug Gregor
7c0e087cd5 [SIL] Extend the string_literal instruction with an 'objc_selector' encoding.
As part of SE-0022, introduce an 'objc_selector' encoding for string
literals that places the UTF-8 string literal into the appropriate
segment for uniquing of Objective-C selector names.
2016-01-27 13:57:40 -08:00
Jordan Rose
8aebe8d864 [docs] LibraryEvolution: Public members get a default version.
Specifically, public members (and nested types) within a versioned type are
assumed to be present on the outer type since its introduction unless otherwise
specified. (This saves boilerplate for a type's initial API.)
2016-01-26 17:45:30 -08:00
Jordan Rose
3a7e511eeb [docs] LibraryEvolution: To remove an override, the type must match exactly.
Thanks, Slava!
2016-01-26 17:45:29 -08:00
Slava Pestov
19fe31fde9 IRGen: Emit and use accessors for generic type metadata
Instead of directly emitting calls to swift_getGenericMetadata*() and
referencing metadata templates, call a metadata accessor function
corresponding to the UnboundGenericType of the NominalTypeDecl.

The body of this accessor forwards arguments to a runtime metadata
instantiation function, together with the template.

Also, move some code around, so that metadata accesses which are
only done as part of the body of a metadata accessor function are
handled separately in emitTypeMetadataAccessFunction().

Apart from protocol conformances, this means metadata templates are
no longer referenced from outside the module where they were defined.
2016-01-26 16:00:54 -08:00
Jordan Rose
4f4ec2c48a [docs] LibraryEvolution: Bring back "fixed-size" as a perf assertion. 2016-01-25 16:43:19 -08:00
Jordan Rose
9df9ee9d72 [docs] LibraryEvolution: Weaken "fixed-layout" structs to "fixed-contents".
This drops the requirement that a fixed-layout struct only contain fixed-size
things (which wasn't specified correctly anyway). Slava and Dmitri both
pointed out that the previous definition had several flaws, including not
really scaling to generics. This reduced version only promises that stored
instance properties won't be added, removed, or modified, which is still
enough to do useful optimizations. And in most cases, we'll be able to
infer the full "fixed-size" property of a type from this attribute anyway.

The name "fixed-contents" was chosen to force us to pick a better name later.

The next commit will bring back the "fixed-size" property as a performance
assertion.
2016-01-25 16:43:19 -08:00