mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
dd2d2aff49
We would hit quadratic behavior in `AsyncQueue` when the build system floods us with `build/logMessage` or `build/task(Start|Progress|Finish)` notifications because we record a dependency on all of the pending log message handling tasks. We can extend the improvement made in https://github.com/swiftlang/sourcekit-lsp/pull/1840 to fix this quadratic problem: If the current task depends on a task with metadata that depends on itself (ie. all tasks of metadata that needs to be executed in-order), we only need to depend on the last task with that metadata. This covers many message types and we can now only get into quadratic behavior if we get flooded with two different kinds of messages: One that does not have a self-dependency and one that depends on the message without a self-dependency. In terms of LSP messages, this could be a document read followed by a document update, but I think this is a lot more unlikely than getting spammed with one type of message.
109 lines
3.9 KiB
Swift
109 lines
3.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import BuildServerProtocol
|
|
package import LanguageServerProtocol
|
|
import LanguageServerProtocolExtensions
|
|
import SKLogging
|
|
package import SwiftExtensions
|
|
|
|
/// A lightweight way of describing tasks that are created from handling BSP
|
|
/// requests or notifications for the purpose of dependency tracking.
|
|
package enum BuildSystemMessageDependencyTracker: QueueBasedMessageHandlerDependencyTracker {
|
|
/// A task that modifies some state. It is a barrier for all requests that read state.
|
|
case stateChange
|
|
|
|
/// A task that reads state, such as getting all build targets. These tasks can be run concurrently with other tasks
|
|
/// that read state but needs to wait for all state changes to be handled first.
|
|
case stateRead
|
|
|
|
/// A task that is responsible for logging information to the client. They can be run concurrently to any state read
|
|
/// and changes but logging tasks must be ordered among each other.
|
|
case taskProgress
|
|
|
|
/// Whether this request needs to finish before `other` can start executing.
|
|
package func isDependency(of other: BuildSystemMessageDependencyTracker) -> Bool {
|
|
switch (self, other) {
|
|
case (.stateChange, .stateChange): return true
|
|
case (.stateChange, .stateRead): return true
|
|
case (.stateRead, .stateChange): return true
|
|
case (.stateRead, .stateRead): return false
|
|
case (.taskProgress, .taskProgress): return true
|
|
case (.taskProgress, _): return false
|
|
case (_, .taskProgress): return false
|
|
}
|
|
}
|
|
|
|
package init(_ notification: some NotificationType) {
|
|
switch notification {
|
|
case is FileOptionsChangedNotification:
|
|
self = .stateChange
|
|
case is OnBuildExitNotification:
|
|
self = .stateChange
|
|
case is OnBuildInitializedNotification:
|
|
self = .stateChange
|
|
case is OnBuildLogMessageNotification:
|
|
self = .taskProgress
|
|
case is OnBuildTargetDidChangeNotification:
|
|
self = .stateChange
|
|
case is OnWatchedFilesDidChangeNotification:
|
|
self = .stateChange
|
|
case is TaskFinishNotification:
|
|
self = .taskProgress
|
|
case is TaskProgressNotification:
|
|
self = .taskProgress
|
|
case is TaskStartNotification:
|
|
self = .taskProgress
|
|
default:
|
|
logger.error(
|
|
"""
|
|
Unknown notification \(type(of: notification)). Treating as a stateChange notification. \
|
|
This might lead to sub-optimal performance because it inhibits parallelism.
|
|
"""
|
|
)
|
|
self = .stateRead
|
|
}
|
|
}
|
|
|
|
package init(_ request: some RequestType) {
|
|
switch request {
|
|
case is BuildShutdownRequest:
|
|
self = .stateChange
|
|
case is BuildTargetPrepareRequest:
|
|
self = .stateRead
|
|
case is BuildTargetSourcesRequest:
|
|
self = .stateRead
|
|
case is TaskStartNotification, is TaskProgressNotification, is TaskFinishNotification:
|
|
self = .taskProgress
|
|
case is InitializeBuildRequest:
|
|
self = .stateChange
|
|
case is RegisterForChanges:
|
|
self = .stateChange
|
|
case is TextDocumentSourceKitOptionsRequest:
|
|
self = .stateRead
|
|
case is WorkspaceBuildTargetsRequest:
|
|
self = .stateRead
|
|
case is WorkspaceWaitForBuildSystemUpdatesRequest:
|
|
self = .stateRead
|
|
|
|
default:
|
|
logger.error(
|
|
"""
|
|
Unknown request \(type(of: request)). Treating as a stateChange request. \
|
|
This might lead to sub-optimal performance because it inhibits parallelism.
|
|
"""
|
|
)
|
|
self = .stateChange
|
|
}
|
|
}
|
|
}
|