github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/os/limits_other.go (about)

     1  // +build !linux
     2  //
     3  // Copyright (c) 2018 Uber Technologies, Inc.
     4  //
     5  // Permission is hereby granted, free of charge, to any person obtaining a copy
     6  // of this software and associated documentation files (the "Software"), to deal
     7  // in the Software without restriction, including without limitation the rights
     8  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     9  // copies of the Software, and to permit persons to whom the Software is
    10  // furnished to do so, subject to the following conditions:
    11  //
    12  // The above copyright notice and this permission notice shall be included in
    13  // all copies or substantial portions of the Software.
    14  //
    15  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    16  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    17  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    18  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    19  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    20  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    21  // THE SOFTWARE.
    22  
    23  package xos
    24  
    25  import (
    26  	"errors"
    27  )
    28  
    29  const (
    30  	nonLinuxWarning = "unable to determine process limits on non-linux os"
    31  )
    32  
    33  var (
    34  	errUnableToDetermineProcessLimits     = errors.New(nonLinuxWarning)
    35  	errUnableToRaiseProcessNoFileNonLinux = errors.New("unable to raise no file limits on non-linux os")
    36  )
    37  
    38  // CanGetProcessLimits returns a boolean to signify if it can return limits,
    39  // and a warning message if it cannot.
    40  func CanGetProcessLimits() (bool, string) {
    41  	return false, nonLinuxWarning
    42  }
    43  
    44  // GetProcessLimits returns the known process limits.
    45  func GetProcessLimits() (ProcessLimits, error) {
    46  	return ProcessLimits{}, errUnableToDetermineProcessLimits
    47  }
    48  
    49  // RaiseProcessNoFileToNROpen attempts to raise the process num files
    50  // open limit to the nr_open system value.
    51  func RaiseProcessNoFileToNROpen() (RaiseProcessNoFileToNROpenResult, error) {
    52  	return RaiseProcessNoFileToNROpenResult{}, errUnableToRaiseProcessNoFileNonLinux
    53  }