Merge branch 'swift-3-api-guidelines' into swift-3-indexing-model

Author: Max Moiseev

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!-- Please complete this template before creating pull request. -->
+#### What's in this pull request?
+<!-- Description about pull request. -->
+
+#### Resolved bug number: ([SR-](https://bugs.swift.org/browse/SR-))
+<!-- If this pull request resolves any bugs from Swift bug tracker -->
+
+* * * *
+
+<!-- This selection should only be completed by Swift admin -->
+Before merging this pull request to apple/swift repository:
+- [ ] Test pull request on Swift continuous integration.
+
+<details>
+  <summary>Triggering Swift CI</summary>
+
+The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:
+
+**Smoke Testing**
+
+        Platform     | Comment
+        ------------ | -------------
+        All supported platforms     | @swift-ci Please smoke test
+        OS X platform               | @swift-ci Please smoke test OS X platform
+        Linux platform              | @swift-ci Please smoke test Linux platform
+
+ **Validation Testing**
+
+        Platform     | Comment
+        ------------ | -------------
+        All supported platforms     | @swift-ci Please test
+        OS X platform               | @swift-ci Please test OS X platform
+        Linux platform              | @swift-ci Please test Linux platform
+
+Note: Only members of the Apple organization can trigger swift-ci.
+</details>
+<!-- Thank you for your contribution to Swift! -->

CMakeLists.txt

@@ -140,9 +140,6 @@ option(SWIFT_RUNTIME_CRASH_REPORTER_CLIENT
 set(SWIFT_DARWIN_XCRUN_TOOLCHAIN "XcodeDefault" CACHE STRING
     "The name of the toolchain to pass to 'xcrun'")
 
-set(SWIFT_DARWIN_ICU_INCLUDE_PATH "" CACHE STRING
-    "Path to the directory where the ICU headers are located")
-
 set(SWIFT_DARWIN_STDLIB_INSTALL_NAME_DIR "@rpath" CACHE STRING
     "The directory of the install_name for standard library dylibs")
 
@@ -247,7 +244,6 @@ include(CheckCXXSourceRuns)
 include(CMakeParseArguments)
 include(SwiftTranslateFlag)
 include(SwiftHandleGybSources)
-include(SwiftHandleDTraceSources)
 include(SwiftSetIfArchBitness)
 include(AddSwift)
 include(SwiftConfigureSDK)
@@ -308,7 +304,6 @@ set(SWIFT_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}")
 
 set(SWIFT_RUNTIME_OUTPUT_INTDIR "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin")
 set(SWIFT_LIBRARY_OUTPUT_INTDIR "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib")
-set(SWIFT_INCLUDE_OUTPUT_INTDIR "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/include")
 if("${SWIFT_NATIVE_SWIFT_TOOLS_PATH}" STREQUAL "")
   set(SWIFT_NATIVE_SWIFT_TOOLS_PATH "${SWIFT_RUNTIME_OUTPUT_INTDIR}")
 endif()
@@ -455,6 +450,19 @@ elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "FreeBSD")
 
   set(SWIFT_PRIMARY_VARIANT_SDK_default "FREEBSD")
   set(SWIFT_PRIMARY_VARIANT_ARCH_default "x86_64")
+elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "CYGWIN")
+  configure_sdk_unix(CYGWIN "Cygwin" "windows" "cygwin" "x86_64" "x86_64-unknown-windows-cygnus")
+
+#  set(CMAKE_EXECUTABLE_FORMAT "ELF")
+
+  set(SWIFT_HOST_VARIANT "windows" CACHE STRING
+      "Deployment OS for Swift host tools (the compiler) [windows].")
+
+  set(SWIFT_HOST_VARIANT_SDK "CYGWIN")
+  set(SWIFT_HOST_VARIANT_ARCH "x86_64")
+  
+  set(SWIFT_PRIMARY_VARIANT_SDK_default "CYGWIN")
+  set(SWIFT_PRIMARY_VARIANT_ARCH_default "x86_64")
 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
   # Set defaults.
 
@@ -626,7 +634,6 @@ message(STATUS "  Assertions: ${SWIFT_STDLIB_ASSERTIONS}")
 message(STATUS "")
 
 message(STATUS "Building Swift runtime with:")
-message(STATUS "  Dtrace:                             ${SWIFT_RUNTIME_ENABLE_DTRACE}")
 message(STATUS "  Leak Detection Checker Entrypoints: ${SWIFT_RUNTIME_ENABLE_LEAK_CHECKER}")
 message(STATUS "")
 

CODE_OWNERS.TXT

@@ -28,6 +28,10 @@ N: Argyrios Kyrzidis
 E: [email protected]
 D: IDE, SourceKit, swift-ide-test
 
+N: Luke Larson
+E: [email protected]
+D: Swift Benchmark Suite
+
 N: Chris Lattner
 E: [email protected]
 D: Everything in Swift not covered by someone else

README.md

@@ -24,7 +24,8 @@ modules, eliminating the need for headers and the code duplication they entail.
 
 To read the documentation, start by installing the
 [Sphinx](http://sphinx-doc.org) documentation generator tool (just run
-`easy_install -U Sphinx` from the command line and you're good to go). Once you
+`easy_install -U Sphinx==1.3.4` (more recent versions are currently not supported) 
+from the command line and you're good to go). Once you
  have that, you can build the Swift documentation by going into `docs` and
 typing `make`. This compiles the `.rst` files in the `docs` directory into
 HTML in the `docs/_build/html` directory.

benchmark/cmake/modules/AddSwiftBenchmarkSuite.cmake

@@ -107,7 +107,7 @@ function (swift_benchmark_compile_archopts)
           "-module-name" "${module_name}"
           "-emit-sib"
           "-o" "${sibfile}"
-          "${srcdir}/${module_name_path}.swift" ${extra_sources})
+          "${source}" ${extra_sources})
     endif()
   endforeach()
 
@@ -116,6 +116,7 @@ function (swift_benchmark_compile_archopts)
 
     set(objfile "${objdir}/${module_name}.o")
     set(swiftmodule "${objdir}/${module_name}.swiftmodule")
+    set(source "${srcdir}/${module_name_path}.swift")
     list(APPEND bench_library_objects "${objfile}")
     add_custom_command(
         OUTPUT "${objfile}"
@@ -129,7 +130,7 @@ function (swift_benchmark_compile_archopts)
         "-module-name" "${module_name}"
         "-emit-module" "-emit-module-path" "${swiftmodule}"
         "-o" "${objfile}"
-        "${srcdir}/${module_name_path}.swift" ${extra_sources})
+        "${source}" ${extra_sources})
     if (SWIFT_BENCHMARK_EMIT_SIB)
       set(sibfile "${objdir}/${module_name}.sib")
       list(APPEND bench_library_sibfiles "${sibfile}")
@@ -145,7 +146,7 @@ function (swift_benchmark_compile_archopts)
           "-module-name" "${module_name}"
           "-emit-sib"
           "-o" "${sibfile}"
-          "${srcdir}/${module_name_path}.swift" ${extra_sources})
+          "${source}" ${extra_sources})
     endif()
   endforeach()
 
@@ -157,6 +158,7 @@ function (swift_benchmark_compile_archopts)
     if(module_name)
       set(objfile "${objdir}/${module_name}.o")
       set(swiftmodule "${objdir}/${module_name}.swiftmodule")
+      set(source "${srcdir}/${module_name_path}.swift")
       list(APPEND SWIFT_BENCH_OBJFILES "${objfile}")
       add_custom_command(
           OUTPUT "${objfile}"
@@ -171,7 +173,7 @@ function (swift_benchmark_compile_archopts)
           "-emit-module" "-emit-module-path" "${swiftmodule}"
           "-I" "${objdir}"
           "-o" "${objfile}"
-          "${srcdir}/${module_name_path}.swift")
+          "${source}")
       if (SWIFT_BENCHMARK_EMIT_SIB)
         set(sibfile "${objdir}/${module_name}.sib")
         list(APPEND SWIFT_BENCH_SIBFILES "${sibfile}")
@@ -188,7 +190,7 @@ function (swift_benchmark_compile_archopts)
             "-I" "${objdir}"
             "-emit-sib"
             "-o" "${sibfile}"
-            "${srcdir}/${module_name_path}.swift")
+            "${source}")
       endif()
     endif()
   endforeach()

benchmark/scripts/Benchmark_Driver

@@ -62,7 +62,7 @@ def parse_results(res, optset):
             tests.append(mem_test)
     return tests
 
-def submit_to_LNT(data, url):
+def submit_to_lnt(data, url):
     print "\nSubmitting results to LNT server..."
     json_report = {'input_data': json.dumps(data), 'commit': '1'}
     data = urllib.urlencode(json_report)
@@ -224,7 +224,7 @@ def submit(args):
                    'Start Time': starttime}
     print "End time:\t", endtime
 
-    submit_to_LNT(data, args.lnt_host)
+    submit_to_lnt(data, args.lnt_host)
     return 0
 
 def run(args):

benchmark/scripts/compare_perf_tests.py

@@ -24,24 +24,26 @@
 VERBOSE = 0
 
 # #,TEST,SAMPLES,MIN(ms),MAX(ms),MEAN(ms),SD(ms),MEDIAN(ms)
-SCORERE = re.compile(r"(\d+),[ \t]*(\w+),[ \t]*([\d.]+),[ \t]*([\d.]+)")
-TOTALRE = re.compile(r"()(Totals),[ \t]*([\d.]+),[ \t]*([\d.]+)")
-KEYGROUP = 2
-VALGROUP = 4
+SCORERE = re.compile(r"(\d+),[ \t]*(\w+),[ \t]*([\d.]+),[ \t]*([\d.]+),[ \t]*([\d.]+)")
+TOTALRE = re.compile(r"()(Totals),[ \t]*([\d.]+),[ \t]*([\d.]+),[ \t]*([\d.]+)")
 NUMGROUP = 1
+KEYGROUP = 2
+BESTGROUP = 4
+WORSTGROUP = 5
 
 IsTime = 1
 ShowSpeedup = 1
 PrintAllScores = 0
 
-def parseInt(word):
+def parse_int(word):
     try:
         return int(word)
     except:
         raise Exception("Expected integer value, not " + word)
 
-def getScores(fname):
+def get_scores(fname):
     scores = {}
+    worstscores = {}
     nums = {}
     runs = 0
     f = open(fname)
@@ -58,11 +60,13 @@ def getScores(fname):
                 continue
 
             if VERBOSE:
-                print "  match", m.group(KEYGROUP), m.group(VALGROUP)
+                print "  match", m.group(KEYGROUP), m.group(BESTGROUP)
 
             if not m.group(KEYGROUP) in scores:
                 scores[m.group(KEYGROUP)] = []
-            scores[m.group(KEYGROUP)].append(parseInt(m.group(VALGROUP)))
+                worstscores[m.group(KEYGROUP)] = []
+            scores[m.group(KEYGROUP)].append(parse_int(m.group(BESTGROUP)))
+            worstscores[m.group(KEYGROUP)].append(parse_int(m.group(WORSTGROUP)))
             if is_total:
                 nums[m.group(KEYGROUP)] = ""
             else:
@@ -71,12 +75,12 @@ def getScores(fname):
                 runs = len(scores[m.group(KEYGROUP)])
     finally:
         f.close()
-    return scores, runs, nums
+    return scores, worstscores, runs, nums
 
-def isMaxScore(newscore, maxscore, invert):
+def is_max_score(newscore, maxscore, invert):
     return not maxscore or (newscore > maxscore if not invert else newscore < maxscore)
 
-def compareScores(key, score1, score2, runs, num):
+def compare_scores(key, score1, worstsample1, score2, worstsample2, runs, num):
     print num.rjust(3),
     print key.ljust(25),
     bestscore1 = None
@@ -87,20 +91,26 @@ def compareScores(key, score1, score2, runs, num):
     minworst = not minbest
     r = 0
     for score in score1:
-        if isMaxScore(newscore=score, maxscore=bestscore1, invert=minbest):
+        if is_max_score(newscore=score, maxscore=bestscore1, invert=minbest):
             bestscore1 = score
-        if isMaxScore(newscore=score, maxscore=worstscore1, invert=minworst):
+        if is_max_score(newscore=score, maxscore=worstscore1, invert=minworst):
             worstscore1 = score
         if PrintAllScores:
             print ("%d" % score).rjust(16),
+    for score in worstsample1:
+        if is_max_score(newscore=score, maxscore=worstscore1, invert=minworst):
+            worstscore1 = score
     for score in score2:
-        if isMaxScore(newscore=score, maxscore=bestscore2, invert=minbest):
+        if is_max_score(newscore=score, maxscore=bestscore2, invert=minbest):
             bestscore2 = score
-        if isMaxScore(newscore=score, maxscore=worstscore2, invert=minworst):
+        if is_max_score(newscore=score, maxscore=worstscore2, invert=minworst):
             worstscore2 = score
         if PrintAllScores:
             print ("%d" % score).rjust(16),
         r += 1
+    for score in worstsample2:
+        if is_max_score(newscore=score, maxscore=worstscore2, invert=minworst):
+            worstscore2 = score
     while r < runs:
         if PrintAllScores:
             print ("0").rjust(9),
@@ -123,21 +133,23 @@ def compareScores(key, score1, score2, runs, num):
         print "*".rjust(9),
         if ShowSpeedup:
             print "*".rjust(9),
-    # if the interval endpoints have inverse relationship, then they overlap
+    # check if the worst->best interval for each configuration overlap.
     if minbest:
-        if bestscore1 < worstscore2:
-            print "(!)",
+        if (bestscore1 < bestscore2 and bestscore2 < worstscore1) \
+           or (bestscore2 < bestscore1 and bestscore1 < worstscore2):
+            print "(?)",
     else:
-        if bestscore1 > worstscore2:
-            print "(!)",
+        if (worstscore1 < worstscore2 and worstscore2 < bestscore1) \
+           or (worstscore2 < worstscore1 and worstscore1 < bestscore2):
+            print "(?)",
     print
 
-def printBestScores(key, scores):
+def print_best_scores(key, scores):
     print key,
     bestscore = None
     minbest = IsTime
     for score in scores:
-        if isMaxScore(newscore=score, maxscore=bestscore, invert=minbest):
+        if is_max_score(newscore=score, maxscore=bestscore, invert=minbest):
             bestscore = score
     print ", %d" % bestscore
 
@@ -151,19 +163,19 @@ def usage():
         sys.exit(1)
     file1 = sys.argv[1]
     if len(sys.argv) < 3:
-        scores, runs, nums = getScores(file1)
+        scores, worstscores, runs, nums = get_scores(file1)
         keys = list(set(scores.keys()))
         keys.sort()
         for key in keys:
-            printBestScores(key, scores[key])
+            print_best_scores(key, scores[key])
         sys.exit(0)
 
     file2 = sys.argv[2]
     if len(sys.argv) > 3:
         SCORERE = re.compile(sys.argv[3])
 
-    scores1, runs1, nums = getScores(file1)
-    scores2, runs2, nums = getScores(file2)
+    scores1, worstscores1, runs1, nums = get_scores(file1)
+    scores2, worstscores2, runs2, nums = get_scores(file2)
 
     runs = runs1
     if runs2 > runs:
@@ -201,4 +213,4 @@ def usage():
         if key not in scores2:
             print key, "not in", file2
             continue
-        compareScores(key, scores1[key], scores2[key], runs, nums[key])
+        compare_scores(key, scores1[key], worstscores1[key], scores2[key], worstscores2[key], runs, nums[key])

benchmark/single-source/Hash.swift

@@ -52,7 +52,7 @@ class Hash {
     return x
   }
 
-  func digestFast(inout Res : [UInt8]) {
+  func digestFast(Res: inout [UInt8]) {
     fillBlock()
     hash()
     // We use [UInt8] to avoid using String::append.
@@ -76,7 +76,7 @@ class Hash {
   func hashState() -> String {
     fatalError("Pure virtual")
   }
-  func hashStateFast(inout Res : [UInt8]) {
+  func hashStateFast(Res: inout [UInt8]) {
     fatalError("Pure virtual")
   }
 
@@ -102,7 +102,7 @@ class Hash {
   }
 
   final
-  func toHexFast(In: UInt32, inout _ Res: Array<UInt8>, _ Index : Int) {
+  func toHexFast(In: UInt32, _ Res: inout Array<UInt8>, _ Index : Int) {
     var In = In
     for i in 0..<4 {
       // Convert one byte each iteration.
@@ -178,7 +178,7 @@ class MD5 : Hash {
     dataLength = 0
   }
 
-  func appendBytes(Val: Int, inout _ Message: Array<UInt8>, _ Offset : Int) {
+  func appendBytes(Val: Int, _ Message: inout Array<UInt8>, _ Offset : Int) {
     Message[Offset] = UInt8(truncatingBitPattern: Val)
     Message[Offset + 1] = UInt8(truncatingBitPattern: Val >> 8)
     Message[Offset + 2] = UInt8(truncatingBitPattern: Val >> 16)
@@ -290,7 +290,7 @@ class MD5 : Hash {
   }
 
   override
-  func hashStateFast(inout Res : [UInt8]) {
+  func hashStateFast(Res: inout [UInt8]) {
 #if !NO_RANGE
     var Idx : Int = 0
     for h in [h0, h1, h2, h3] {