aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/comms/ipc.go
blob: 3ba747b1de1723b3cb45d267ab3f699b05a8545f (plain) (blame)
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
// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package comms

import (
    "fmt"
    "math/rand"
    "net"
    "os"

    "encoding/json"

    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/rpc/codec"
    "github.com/ethereum/go-ethereum/rpc/shared"
)

type Stopper interface {
    Stop()
}

type InitFunc func(conn net.Conn) (Stopper, shared.EthereumApi, error)

type IpcConfig struct {
    Endpoint string
}

type ipcClient struct {
    endpoint string
    c        net.Conn
    codec    codec.Codec
    coder    codec.ApiCoder
}

func (self *ipcClient) Close() {
    self.coder.Close()
}

func (self *ipcClient) Send(msg interface{}) error {
    var err error
    if err = self.coder.WriteResponse(msg); err != nil {
        if err = self.reconnect(); err == nil {
            err = self.coder.WriteResponse(msg)
        }
    }
    return err
}

func (self *ipcClient) Recv() (interface{}, error) {
    return self.coder.ReadResponse()
}

func (self *ipcClient) SupportedModules() (map[string]string, error) {
    req := shared.Request{
        Id:      1,
        Jsonrpc: "2.0",
        Method:  "rpc_modules",
    }

    if err := self.coder.WriteResponse(req); err != nil {
        return nil, err
    }

    res, _ := self.coder.ReadResponse()
    if sucRes, ok := res.(*shared.SuccessResponse); ok {
        data, _ := json.Marshal(sucRes.Result)
        modules := make(map[string]string)
        if err := json.Unmarshal(data, &modules); err == nil {
            return modules, nil
        }
    }

    // old version uses modules instead of rpc_modules, this can be removed after full migration
    req.Method = "modules"
    if err := self.coder.WriteResponse(req); err != nil {
        return nil, err
    }

    res, err := self.coder.ReadResponse()
    if err != nil {
        return nil, err
    }

    if sucRes, ok := res.(*shared.SuccessResponse); ok {
        data, _ := json.Marshal(sucRes.Result)
        modules := make(map[string]string)
        err = json.Unmarshal(data, &modules)
        if err == nil {
            return modules, nil
        }
    }

    return nil, fmt.Errorf("Invalid response")
}

// Create a new IPC client, UNIX domain socket on posix, named pipe on Windows
func NewIpcClient(cfg IpcConfig, codec codec.Codec) (*ipcClient, error) {
    return newIpcClient(cfg, codec)
}

// Start IPC server
func StartIpc(cfg IpcConfig, codec codec.Codec, initializer InitFunc) error {
    l, err := ipcListen(cfg)
    if err != nil {
        return err
    }
    go ipcLoop(cfg, codec, initializer, l)
    return nil
}

// CreateListener creates an listener, on Unix platforms this is a unix socket, on Windows this is a named pipe
func CreateListener(cfg IpcConfig) (net.Listener, error) {
    return ipcListen(cfg)
}

func ipcLoop(cfg IpcConfig, codec codec.Codec, initializer InitFunc, l net.Listener) {
    glog.V(logger.Info).Infof("IPC service started (%s)\n", cfg.Endpoint)
    defer os.Remove(cfg.Endpoint)
    defer l.Close()
    for {
        conn, err := l.Accept()
        if err != nil {
            glog.V(logger.Debug).Infof("accept: %v", err)
            return
        }
        id := newIpcConnId()
        go func() {
            defer conn.Close()
            glog.V(logger.Debug).Infof("new connection with id %06d started", id)
            stopper, api, err := initializer(conn)
            if err != nil {
                glog.V(logger.Error).Infof("Unable to initialize IPC connection: %v", err)
                return
            }
            defer stopper.Stop()
            handle(id, conn, api, codec)
        }()
    }
}

func newIpcConnId() int {
    return rand.Int() % 1000000
}