github.com/ethereum/go-ethereum@v1.14.3/rpc/ipc_unix.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  //go:build darwin || dragonfly || freebsd || linux || nacl || netbsd || openbsd || solaris
    18  // +build darwin dragonfly freebsd linux nacl netbsd openbsd solaris
    19  
    20  package rpc
    21  
    22  import (
    23  	"context"
    24  	"fmt"
    25  	"net"
    26  	"os"
    27  	"path/filepath"
    28  	"syscall"
    29  
    30  	"github.com/ethereum/go-ethereum/log"
    31  )
    32  
    33  const (
    34  	// The limit of unix domain socket path diverse between OS, on Darwin it's 104 bytes
    35  	// but on Linux it's 108 byte, so we should depend on syscall.RawSockaddrUnix's
    36  	// definition dynamically
    37  	maxPathSize = len(syscall.RawSockaddrUnix{}.Path)
    38  )
    39  
    40  // ipcListen will create a Unix socket on the given endpoint.
    41  func ipcListen(endpoint string) (net.Listener, error) {
    42  	// account for null-terminator too
    43  	if len(endpoint)+1 > maxPathSize {
    44  		log.Warn(fmt.Sprintf("The ipc endpoint is longer than %d characters. ", maxPathSize-1),
    45  			"endpoint", endpoint)
    46  	}
    47  
    48  	// Ensure the IPC path exists and remove any previous leftover
    49  	if err := os.MkdirAll(filepath.Dir(endpoint), 0751); err != nil {
    50  		return nil, err
    51  	}
    52  	os.Remove(endpoint)
    53  	l, err := net.Listen("unix", endpoint)
    54  	if err != nil {
    55  		return nil, err
    56  	}
    57  	os.Chmod(endpoint, 0600)
    58  	return l, nil
    59  }
    60  
    61  // newIPCConnection will connect to a Unix socket on the given endpoint.
    62  func newIPCConnection(ctx context.Context, endpoint string) (net.Conn, error) {
    63  	return new(net.Dialer).DialContext(ctx, "unix", endpoint)
    64  }