File: Tracing.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (187 lines) | stat: -rw-r--r-- 4,888 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2020 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */

import Foundation

public enum TracingEventType: String, Codable, Sendable {
    case asyncBegin
    case asyncEnd
}

public protocol TracingEventProtocol {
    /// The category of the event.
    var cat: String { get }

    /// The name of the event.
    var name: String { get }

    /// The free form id of the event.
    var id: String { get }

    /// The phase of the event.
    var ph: TracingEventType { get }

    /// The process id of the process where the event occured.
    var pid: Int { get }

    /// The thread id of the process where the event occured.
    var tid: Int { get }

    /// The timestamp of the event.
    var ts: Int { get }

    /// The start time of the process where the event occured.
    var startTs: Int { get }
    init(
        cat: String,
        name: String,
        id: String,
        ph: TracingEventType,
        pid: Int,
        tid: Int,
        ts: Int,
        startTs: Int
    )
}

public protocol TracingCollectionProtocol: Sendable {
    var events: [TracingEventProtocol] { get set }
    init(_ events: [TracingEventProtocol])
}

extension TracingCollectionProtocol {
    public mutating func append(_ tracingCollection: TracingCollectionProtocol) {
        self.events.append(contentsOf: tracingCollection.events)
    }
}

public struct TracingEvent: TracingEventProtocol, Codable, Sendable {
    public let cat: String
    public let name: String
    public let id: String
    public let ph: TracingEventType
    public let pid: Int
    public let tid: Int
    public let ts: Int
    public let startTs: Int

    #if canImport(Darwin)
    public init(
        cat: String,
        name: String,
        id: String,
        ph: TracingEventType,
        pid: Int = Int(getpid()),
        tid: Int = Int(pthread_mach_thread_np(pthread_self())),
        ts: Int = Int(DispatchTime.now().uptimeNanoseconds),
        startTs: Int = 0
    ) {
        self.cat = cat
        self.name = name
        self.id = id
        self.ph = ph
        self.pid = pid
        self.tid = tid
        self.ts = ts
        self.startTs = startTs
    }
    #elseif canImport(Glibc) || canImport(Android)
    public init(
        cat: String,
        name: String,
        id: String,
        ph: TracingEventType,
        pid: Int = Int(getpid()),
        tid: Int = 1,
        ts: Int = Int(DispatchTime.now().uptimeNanoseconds),
        startTs: Int = 0
    ) {
        self.cat = cat
        self.name = name
        self.id = id
        self.ph = ph
        self.pid = pid
        self.tid = tid
        self.ts = ts
        self.startTs = startTs
    }
    #else
    public init(
        cat: String,
        name: String,
        id: String,
        ph: TracingEventType,
        pid: Int = 1,
        tid: Int = 1,
        ts: Int = Int(DispatchTime.now().uptimeNanoseconds),
        startTs: Int = 0
    ) {
        self.cat = cat
        self.name = name
        self.id = id
        self.ph = ph
        self.pid = pid
        self.tid = tid
        self.ts = ts
        self.startTs = startTs
    }
    #endif
}

public final class TracingCollection {
    private let lock = NSLock()
    private var _events: [TracingEventProtocol] = []

    public var events: [TracingEventProtocol] {
        get {
            return self.lock.withLock {
                self._events
            }
        }

        set {
            self.lock.withLock {
                self._events = newValue
            }
        }
    }

    public required init(_ events: [TracingEventProtocol] = []) {
        self.events = events
    }
}

#if compiler(>=5.7)
extension TracingCollection: @unchecked /* because self-locked */ Sendable {}
extension TracingCollection: TracingCollectionProtocol {}
#else
extension TracingCollection: UnsafeSendable {}
extension TracingCollection: TracingCollectionProtocol {}
#endif

extension Context {
    public static func withTracing(_ collection: TracingCollectionProtocol) -> Context {
        return Context(dictionaryLiteral: (ObjectIdentifier(TracingCollectionProtocol.self), collection as Any))
    }

    public mutating func enrichWithTracing(_ collection: TracingCollectionProtocol) -> Context {
        self[ObjectIdentifier(TracingCollectionProtocol.self)] = collection
        return self
    }

    public var tracing: TracingCollectionProtocol? {
        get {
            return self[ObjectIdentifier(TracingCollectionProtocol.self), as: TracingCollectionProtocol.self]
        }
        set {
            self[ObjectIdentifier(TracingCollectionProtocol.self)] = newValue
        }
    }
}