pinned-init 0.0.10

Library to facilitate safe pinned initialization
Documentation
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
permissions:
  contents: read
on:
  push:
    branches: [main, kernel, next]
  pull_request:
  workflow_dispatch:
  schedule:
    - cron: '7 7 * * *'

name: CI
jobs:
  fmt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rustfmt
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo fmt --check --all' --root
  readme:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
      - run: cargo install cargo-rdme
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo rdme --check' --root
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo doc --all-features --no-deps' --root
        env:
          RUSTFLAGS: "-Dwarnings"
  clippy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: clippy
      - run: cargo install cargo-hack
      - run: git config user.name "github-runner" && git config user.email "<>"
      # examples and tests require `alloc`, since they make extensive use of `Box` etc.
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            clippy \
            --all-targets \
            --locked \
            --features alloc
          cargo clean' > exec.sh
          git rebase --exec 'bash exec.sh' --root
        env:
          RUSTFLAGS: "-Dwarnings"
      # the core lib does not, so also check that without the alloc feature.
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            clippy \
            --lib \
            --locked
          cargo clean' > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          RUSTFLAGS: "-Dwarnings"
  ui-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: cargo install cargo-expand
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo test ui_ --locked --all-targets' --root
        env:
          RUSTFLAGS: >
            -Dwarnings
            --cfg UI_TESTS
  nightly:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        kind:
          - "check --all-targets"
          - "test --all-targets"
          # doctests are strangely not included in --all-targets
          - "--features default test --doc"
    name: "nightly/${{matrix.kind}}"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: cargo install cargo-expand
      - run: cargo install cargo-hack
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            ${{matrix.kind}} \
            --locked
          cargo clean' > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          RUSTFLAGS: "-Dwarnings"
  beta:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        kind:
          - "check --all-targets"
          - "test --all-targets"
          # doctests are strangely not included in --all-targets
          - "--features default test --doc"
    name: "beta/${{matrix.kind}}"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@beta
        with:
          components: rust-src
      - run: cargo install cargo-expand
      - run: cargo install cargo-hack
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            ${{matrix.kind}} \
            --locked
          cargo clean' > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          RUSTFLAGS: "-Dwarnings"
          RUSTC_BOOTSTRAP: 1
  miri:
    runs-on: ubuntu-latest
    name: "miri (${{matrix.MIRIFLAGS}})"
    strategy:
      matrix:
        MIRIFLAGS:
          - ""
          - "-Zmiri-tree-borrows"
          - "-Zmiri-strict-provenance"
          - "-Zmiri-tree-borrows -Zmiri-strict-provenance"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - run: |
          echo "NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)" >> $GITHUB_ENV
      - name: Install ${{env.NIGHTLY}}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{env.NIGHTLY}}
          components: miri, rust-src
      - run: cargo install cargo-expand
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo miri test --locked --all-targets' --root
        env:
          RUSTFLAGS: "-Dwarnings"
          MIRIFLAGS: ${{matrix.MIRIFLAGS}}
      # doctests are strangely not included in --all-targets
      - run: git rebase --exec 'cargo miri test --locked --doc' --root
        env:
          RUSTFLAGS: "-Dwarnings"
          MIRIFLAGS: ${{matrix.MIRIFLAGS}}
  sanitizers:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        targets: ["--doc", "--all-targets"]
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - name: enable debug symbols
        run: |
          sudo apt install llvm
      - run: git config user.name "github-runner" && git config user.email "<>"
      # sed because of https://github.com/japaric/rust-san#unrealiable-leaksanitizer
      - run: |
          echo "#!/bin/bash
          set -e
          sed -i '/\[features\]/i [profile.dev]' Cargo.toml \
            && sed -i '/profile.dev/a opt-level = 1' Cargo.toml \
            && cargo test --lib --tests --target x86_64-unknown-linux-gnu \
            && git restore Cargo.toml" > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          ASAN_OPTIONS: "detect_odr_violation=0:detect_leaks=0"
          RUSTFLAGS: >
            --cfg NO_ALLOC_FAIL_TESTS
            -Z sanitizer=address
            -Dwarnings
      # sed because of https://github.com/japaric/rust-san#unrealiable-leaksanitizer
      # doctests are strangely not included in --all-targets
      - run: |
          echo "#!/bin/bash
          set -e
          sed -i '/\[features\]/i [profile.dev]' Cargo.toml \
            && sed -i '/profile.dev/a opt-level = 1' Cargo.toml \
            && cargo test --doc --target x86_64-unknown-linux-gnu \
            && git restore Cargo.toml" > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          ASAN_OPTIONS: "detect_odr_violation=0:detect_leaks=0"
          RUSTFLAGS: >
            --cfg NO_ALLOC_FAIL_TESTS
            -Z sanitizer=address
            -Dwarnings
      - run: |
          git rebase --exec \
            'cargo test --all-targets --target x86_64-unknown-linux-gnu' \
            --root
        env:
          RUSTFLAGS: >
            --cfg NO_ALLOC_FAIL_TESTS
            -Z sanitizer=leak
            -Dwarnings
      # doctests are strangely not included in --all-targets
      - run: |
          git rebase --exec \
            'cargo test --doc --target x86_64-unknown-linux-gnu' \
            --root
        env:
          RUSTFLAGS: >
            --cfg NO_ALLOC_FAIL_TESTS
            -Z sanitizer=leak
            -Dwarnings
  msrv:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        kind: ["check", "test"]
    name: "msrv/${{matrix.kind}}"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@stable
      - run: cargo install cargo-hack
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            --exclude-features alloc \
            --exclude-features unsafe-pinned \
            --exclude-features default \
            --version-range 1.82.. \
            --clean-per-version \
            ${{matrix.kind}} \
            --locked \
            --all-targets
          cargo clean' > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          RUSTFLAGS: "-Dwarnings"
  nightly-msrv:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rust-src
      - run: cargo install cargo-hack
      - run: cargo install cargo-expand
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          echo '#!/bin/bash
          set -e
          cargo hack \
            --clean-per-run \
            --feature-powerset \
            --version-range 1.78.. \
            --clean-per-version \
            check \
            --locked \
            --all-targets
          cargo clean' > exec.sh
          git rebase --exec "bash exec.sh" --root
        env:
          RUSTC_BOOTSTRAP: 1
          RUSTFLAGS: "-Dwarnings"
  os-check:
    strategy:
      fail-fast: false
      matrix:
        os: [macos-latest, windows-latest]
    runs-on: ${{matrix.os}}
    name: "os-check (${{matrix.os}})"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: cargo install cargo-expand
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: git rebase --exec 'cargo test --all-targets --locked' --root
        env:
          RUSTFLAGS: "-Dwarnings"
      # doctests are strangely not included in --all-targets
      - run: git rebase --exec 'cargo test --doc --locked' --root
        env:
          RUSTFLAGS: "-Dwarnings"
  signed-off-by:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          git rebase --exec \
            'git log --no-merges -1 --pretty=format:%B | grep -q "^Signed-off-by:"' \
            --root
  apply:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          repository: Rust-for-Linux/linux
          path: "kernel"
          ref: pin-init-next
      - uses: actions/checkout@v4
        with:
          path: "pin-init"
          fetch-depth: 0
          ref: ${{github.event.pull_request.head.sha}}
      - run: |
          pushd kernel
          git config user.name "github-runner" && git config user.email "<>"
          popd # kernel

          pushd pin-init
          git config user.name "github-runner" && git config user.email "<>"
          git fetch
          if [ "$(git rev-parse HEAD)" = "$(git rev-parse origin/next)" ]; then
              # when there are no new commits, we can succeed directly
              exit 0
          fi
          if ! yes | bash ./to-kernel.sh ../kernel origin/next; then
              if ! git am --3way; then
                  git am --show-current-patch=diff
                  false
              fi
              false
          fi
  link-heartbeat:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: ${{github.event.pull_request.commits}}
          ref: ${{github.event.pull_request.head.sha}}
      - uses: dtolnay/rust-toolchain@nightly
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: sudo apt-get install -y linkchecker
      - run: git config user.name "github-runner" && git config user.email "<>"
      - run: |
          git rebase --exec \
            'cargo doc --all-features --no-deps && linkchecker target/doc/*/*.html' \
            --root
        env:
          RUSTFLAGS: "-Dwarnings"
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: rust-src
      - run: cargo install cargo-expand
      - run: cargo update
      - run: cargo test --locked
        env:
          RUSTFLAGS: "-Ddeprecated -Dwarnings"