github.com/pawelgaczynski/giouring@v0.0.0-20230826085535-69588b89acb9/ring.go (about)

     1  // MIT License
     2  //
     3  // Copyright (c) 2023 Paweł Gaczyński
     4  //
     5  // Permission is hereby granted, free of charge, to any person obtaining a
     6  // copy of this software and associated documentation files (the
     7  // "Software"), to deal in the Software without restriction, including
     8  // without limitation the rights to use, copy, modify, merge, publish,
     9  // distribute, sublicense, and/or sell copies of the Software, and to
    10  // permit persons to whom the Software is furnished to do so, subject to
    11  // the following conditions:
    12  //
    13  // The above copyright notice and this permission notice shall be included
    14  // in all copies or substantial portions of the Software.
    15  //
    16  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    17  // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    18  // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    19  // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    20  // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    21  // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    22  // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    23  
    24  package giouring
    25  
    26  const (
    27  	IntFlagRegRing    uint8 = 1
    28  	IntFlagRegRegRing uint8 = 2
    29  	IntFlagAppMem     uint8 = 4
    30  )
    31  
    32  func NewRing() *Ring {
    33  	return &Ring{
    34  		sqRing: &SubmissionQueue{},
    35  		cqRing: &CompletionQueue{},
    36  	}
    37  }
    38  
    39  func CreateRing(entries uint32) (*Ring, error) {
    40  	var (
    41  		ring  = NewRing()
    42  		flags uint32
    43  	)
    44  
    45  	err := ring.QueueInit(entries, flags)
    46  	if err != nil {
    47  		return nil, err
    48  	}
    49  
    50  	return ring, nil
    51  }