View Javadoc
1   /*
2    * Copyright 2024 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.channel.uring;
17  
18  
19  final class RingBuffer {
20      private final SubmissionQueue ioUringSubmissionQueue;
21      private final CompletionQueue ioUringCompletionQueue;
22      private final int features;
23  
24      RingBuffer(SubmissionQueue ioUringSubmissionQueue,
25                 CompletionQueue ioUringCompletionQueue, int features) {
26          this.ioUringSubmissionQueue = ioUringSubmissionQueue;
27          this.ioUringCompletionQueue = ioUringCompletionQueue;
28          this.features = features;
29      }
30  
31      /**
32       * Enable ring. This method must be called from the same method that will call {@link SubmissionQueue#submit()} and
33       * {@link SubmissionQueue#submitAndWait()}.
34       */
35      void enable() {
36          // We create our ring in disabled mode and so need to enable it first.
37          Native.ioUringRegisterEnableRings(fd());
38          // Now also register the ring filedescriptor itself. This needs to happen in the same thread
39          // that will also call the io_uring_enter(...)
40          ioUringSubmissionQueue.tryRegisterRingFd();
41      }
42  
43      int fd() {
44          return ioUringCompletionQueue.ringFd;
45      }
46  
47      int features() {
48          return features;
49      }
50  
51      SubmissionQueue ioUringSubmissionQueue() {
52          return this.ioUringSubmissionQueue;
53      }
54  
55      CompletionQueue ioUringCompletionQueue() {
56          return this.ioUringCompletionQueue;
57      }
58  
59      void close() {
60          Native.ioUringExit(
61                  ioUringSubmissionQueue.submissionQueueArrayAddress,
62                  ioUringSubmissionQueue.ringEntries,
63                  ioUringSubmissionQueue.ringAddress,
64                  ioUringSubmissionQueue.ringSize,
65                  ioUringCompletionQueue.ringAddress,
66                  ioUringCompletionQueue.ringSize,
67                  ioUringSubmissionQueue.ringFd,
68                  ioUringSubmissionQueue.enterRingFd);
69      }
70  }