├── go.mod ├── go.sum ├── .gitignore ├── .travis.yml ├── Makefile ├── memcache_res_test.go ├── LICENSE ├── memcache_res.go ├── README.md ├── memcache_req_test.go ├── memcached_test.go ├── memcached.go └── memcache_req.go /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/rpcxio/gomemcached 2 | 3 | go 1.13 4 | 5 | require github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b 6 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b h1:L/QXpzIa3pOvUGt1D1lA5KjYhPBAN/3iWdP7xeFS9F0= 2 | github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA= 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.dll 4 | *.so 5 | *.dylib 6 | 7 | # Test binary, build with `go test -c` 8 | *.test 9 | 10 | # Output of the go coverage tool, specifically when used with LiteIDE 11 | *.out 12 | 13 | # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 14 | .glide/ 15 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | 4 | go: 5 | - 1.9.x 6 | - tip 7 | 8 | before_script: 9 | - go get -t -v github.com/smallnest/gomemcached 10 | - go get github.com/mattn/goveralls 11 | 12 | script: 13 | - go build . 14 | - goveralls -service=travis-ci 15 | 16 | notifications: 17 | email: 18 | recipients: smallnest@gmail.com 19 | on_success: change 20 | on_failure: always -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | WORKDIR=`pwd` 2 | 3 | default: build 4 | 5 | install: 6 | go get github.com/smallnest/gomemcached 7 | 8 | vet: 9 | go vet . 10 | 11 | tools: 12 | go get honnef.co/go/tools/cmd/staticcheck 13 | go get honnef.co/go/tools/cmd/gosimple 14 | go get honnef.co/go/tools/cmd/unused 15 | go get github.com/gordonklaus/ineffassign 16 | go get github.com/fzipp/gocyclo 17 | go get github.com/golang/lint/golint 18 | 19 | lint: 20 | golint ./... 21 | 22 | staticcheck: 23 | staticcheck -ignore "$(shell cat .checkignore)" . 24 | 25 | gosimple: 26 | gosimple -ignore "$(shell cat .gosimpleignore)" . 27 | 28 | unused: 29 | unused . 30 | 31 | gocyclo: 32 | @ gocyclo -over 55 $(shell find . -name "*.go" |egrep -v "pb\.go|_test\.go") 33 | 34 | check: staticcheck gosimple unused gocyclo 35 | 36 | doc: 37 | godoc -http=:6060 38 | 39 | deps: 40 | go list -f '{{ join .Deps "\n"}}' . |grep "/" | grep -v "github.com/smallnest/gomemcached"| grep "\." | sort |uniq 41 | 42 | fmt: 43 | go fmt . 44 | 45 | build: 46 | go build . 47 | 48 | test: 49 | go test . 50 | -------------------------------------------------------------------------------- /memcache_res_test.go: -------------------------------------------------------------------------------- 1 | package mc 2 | 3 | import ( 4 | "testing" 5 | ) 6 | 7 | func TestRespEmpty(t *testing.T) { 8 | var res Response 9 | 10 | r := res.String() 11 | 12 | if r != "\r\n" { 13 | t.Errorf("Empty response is not empty: %v", r) 14 | } 15 | } 16 | 17 | func TestRespEnd(t *testing.T) { 18 | res := Response{Response: "END"} 19 | r := res.String() 20 | 21 | if r != "END\r\n" { 22 | t.Errorf("%v", r) 23 | } 24 | } 25 | 26 | func TestRespValueEnd(t *testing.T) { 27 | res := Response{ 28 | "END", 29 | []Value{ 30 | Value{"k1", "f1", []byte("123"), ""}, 31 | }, 32 | } 33 | r := res.String() 34 | 35 | if r != "VALUE k1 f1 3\r\n123\r\nEND\r\n" { 36 | t.Errorf("%v", r) 37 | } 38 | } 39 | 40 | func TestRespMultipleValue(t *testing.T) { 41 | res := Response{ 42 | "END", 43 | []Value{ 44 | Value{"k1", "f1", []byte("123"), ""}, 45 | Value{"k2", "f2", []byte("456"), ""}, 46 | }, 47 | } 48 | r := res.String() 49 | 50 | if r != "VALUE k1 f1 3\r\n123\r\nVALUE k2 f2 3\r\n456\r\nEND\r\n" { 51 | t.Errorf("%v", r) 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 smallnest 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 all 13 | 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 THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /memcache_res.go: -------------------------------------------------------------------------------- 1 | package mc 2 | 3 | import ( 4 | "bytes" 5 | "strconv" 6 | ) 7 | 8 | // Response is a memcached response. 9 | type Response struct { 10 | Response string 11 | Values []Value 12 | } 13 | 14 | // Value is data in responses. 15 | type Value struct { 16 | Key, Flags string 17 | //Exptime time.Time 18 | Data []byte 19 | Cas string 20 | } 21 | 22 | // String converts Response to string to send over wire. 23 | func (r Response) String() string { 24 | // format: 25 | // VALUE []\r\n 26 | //\r\n 27 | 28 | var b bytes.Buffer 29 | 30 | for i := range r.Values { 31 | //b.WriteString(fmt.Sprintf("VALUE %s %s %d\r\n", r.Values[i].Key, r.Values[i].Flags, len(r.Values[i].Data))) 32 | b.WriteString("VALUE ") 33 | b.WriteString(r.Values[i].Key) 34 | b.WriteString(" ") 35 | b.WriteString(r.Values[i].Flags) 36 | b.WriteString(" ") 37 | b.WriteString(strconv.Itoa(len(r.Values[i].Data))) 38 | 39 | if r.Values[i].Cas != "" { 40 | b.WriteString(" ") 41 | b.WriteString(r.Values[i].Cas) 42 | } 43 | 44 | b.WriteString("\r\n") 45 | 46 | b.Write(r.Values[i].Data) 47 | b.WriteString("\r\n") 48 | } 49 | 50 | b.WriteString(r.Response) 51 | b.WriteString("\r\n") 52 | 53 | return b.String() 54 | } 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gomemcached 2 | Memcached protocol implementation for memcached server. 3 | You can use it to create a memcached server easily. 4 | 5 | [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![GoDoc](https://godoc.org/github.com/rpcxio/gomemcached?status.png)](http://godoc.org/github.com/rpcxio/gomemcached) [![travis](https://travis-ci.org/smallnest/gomemcached.svg?branch=master)](https://travis-ci.org/smallnest/gomemcached) [![Go Report Card](https://goreportcard.com/badge/github.com/rpcxio/gomemcached)](https://goreportcard.com/report/github.com/rpcxio/gomemcached) [![Coverage Status](https://coveralls.io/repos/smallnest/gomemcached/badge.svg?branch=master&service=github)](https://coveralls.io/github/smallnest/gomemcached?branch=master) 6 | 7 | 8 | import this lib: 9 | 10 | ```sh 11 | go get -u github.com/rpcxio/gomemcached 12 | ``` 13 | 14 | 15 | And register handlers. 16 | 17 | ```go 18 | addr := "127.0.0.1:" + strconv.Itoa(port) 19 | // or use unix domain socket, like: 20 | // addr := "unix:///tmp/memcached.sock" 21 | 22 | mockServer := NewServer(addr) 23 | 24 | mockServer.RegisterFunc("get", DefaultGet) 25 | mockServer.RegisterFunc("gets", DefaultGet) 26 | mockServer.RegisterFunc("set", DefaultSet) 27 | mockServer.RegisterFunc("delete", DefaultDelete) 28 | mockServer.RegisterFunc("incr", DefaultIncr) 29 | mockServer.RegisterFunc("flush_all", DefaultFlushAll) 30 | mockServer.RegisterFunc("version", DefaultVersion) 31 | 32 | mockServer.Start() 33 | ``` 34 | 35 | 36 | This project refers to the below projects: 37 | 38 | - [luxuan/go-memcached-server](https://github.com/luxuan/go-memcached-server) 39 | - [zobo/mrproxy](https://github.com/zobo/mrproxy) 40 | 41 | I added more implementation and fix some issues, for example, panic on reading long value. I also add `Context` in handlers so that we can pass more info to handlers. -------------------------------------------------------------------------------- /memcache_req_test.go: -------------------------------------------------------------------------------- 1 | package mc 2 | 3 | import ( 4 | "bufio" 5 | "reflect" 6 | "strings" 7 | "testing" 8 | ) 9 | 10 | func testReq(in string, t *testing.T) (ret *Request, err error) { 11 | r := strings.NewReader(in) 12 | return ReadRequest(bufio.NewReader(r)) 13 | } 14 | 15 | func TestSet(t *testing.T) { 16 | ret, err := testReq("set KEY 0 0 10\r\n1234567890\r\n", t) 17 | if err != nil { 18 | t.Fatalf("ReadRequest %+v", err) 19 | } 20 | 21 | if ret.Command != "set" { 22 | t.Errorf("Command %s", ret.Command) 23 | } 24 | if ret.Key != "KEY" { 25 | t.Errorf("Key %s", ret.Key) 26 | } 27 | if ret.Flags != "0" { 28 | t.Errorf("Flags %s", ret.Flags) 29 | } 30 | if ret.Exptime != 0 { 31 | t.Errorf("Exptime %d", ret.Exptime) 32 | } 33 | if string(ret.Data) != "1234567890" { 34 | t.Errorf("Data %s", ret.Data) 35 | } 36 | } 37 | 38 | func TestGet(t *testing.T) { 39 | ret, err := testReq("get a bb c\r\n", t) 40 | if err != nil { 41 | t.Fatalf("ReadRequest %+v", err) 42 | } 43 | 44 | if ret.Command != "get" { 45 | t.Errorf("Command %s", ret.Command) 46 | } 47 | if !reflect.DeepEqual(ret.Keys, []string{"a", "bb", "c"}) { 48 | t.Errorf("Keys %v", ret.Keys) 49 | } 50 | } 51 | 52 | func TestCas(t *testing.T) { 53 | ret, err := testReq("cas KEY 0 0 10 UNIQ\r\n1234567890\r\n", t) 54 | if err != nil { 55 | t.Fatalf("ReadRequest %+v", err) 56 | } 57 | 58 | if ret.Command != "cas" { 59 | t.Errorf("Command %s", ret.Command) 60 | } 61 | if ret.Key != "KEY" { 62 | t.Errorf("Key %s", ret.Key) 63 | } 64 | if ret.Flags != "0" { 65 | t.Errorf("Flags %s", ret.Flags) 66 | } 67 | if ret.Exptime != 0 { 68 | t.Errorf("Exptime %d", ret.Exptime) 69 | } 70 | if ret.Cas != "UNIQ" { 71 | t.Errorf("Cas %d", ret.Exptime) 72 | } 73 | if string(ret.Data) != "1234567890" { 74 | t.Errorf("Data %s", ret.Data) 75 | } 76 | } 77 | 78 | func TestError(t *testing.T) { 79 | _, err := testReq("xxx KEY 0 0 10\r\n1234567890\r\n", t) 80 | if perr, ok := err.(Error); ok { 81 | t.Logf("Good error: %v", perr) 82 | return 83 | } 84 | t.Fatalf("ReadRequest did not return error") 85 | } 86 | -------------------------------------------------------------------------------- /memcached_test.go: -------------------------------------------------------------------------------- 1 | package mc 2 | 3 | import ( 4 | "context" 5 | "net" 6 | "strconv" 7 | "sync" 8 | "testing" 9 | "time" 10 | 11 | "github.com/bradfitz/gomemcache/memcache" 12 | ) 13 | 14 | var ( 15 | mockServer *Server 16 | addr string 17 | ) 18 | 19 | func startMockServer(t *testing.T) { 20 | port, err := getFreePort() 21 | if err != nil { 22 | t.Fatalf("failed to get a free port: %v", err) 23 | } 24 | 25 | addr = "127.0.0.1:" + strconv.Itoa(port) 26 | mockServer = NewServer(addr) 27 | mockServer.RegisterFunc("get", DefaultGet) 28 | mockServer.RegisterFunc("gets", DefaultGet) 29 | mockServer.RegisterFunc("set", DefaultSet) 30 | mockServer.RegisterFunc("delete", DefaultDelete) 31 | mockServer.RegisterFunc("incr", DefaultIncr) 32 | mockServer.RegisterFunc("flush_all", DefaultFlushAll) 33 | mockServer.RegisterFunc("version", DefaultVersion) 34 | mockServer.Start() 35 | } 36 | 37 | func stopMockServer() { 38 | mockServer.Stop() 39 | } 40 | 41 | func TestMemcached(t *testing.T) { 42 | startMockServer(t) 43 | time.Sleep(time.Second) 44 | defer stopMockServer() 45 | 46 | mc := memcache.New(addr) 47 | mc.Set(&memcache.Item{Key: "foo", Value: []byte("my value")}) 48 | 49 | it, err := mc.Get("foo") 50 | if err != nil { 51 | t.Errorf("failed to get: %v", err) 52 | } 53 | 54 | if it == nil || string(it.Value) != "my value" { 55 | t.Errorf("failed to get wrong value: %s", string(it.Value)) 56 | } 57 | 58 | var num uint64 = 1234 59 | s := strconv.FormatUint(num, 10) 60 | mc.Set(&memcache.Item{Key: "num", Value: []byte(s)}) 61 | num, err = mc.Increment("num", uint64(100)) 62 | if err != nil { 63 | t.Errorf("failed to increment: %v", err) 64 | } 65 | 66 | if num != 1334 { 67 | t.Errorf("wrong increment implementation. got: %d", num) 68 | } 69 | 70 | err = mc.Delete("num") 71 | if err != nil { 72 | t.Errorf("failed to delete: %v", err) 73 | } 74 | 75 | err = mc.FlushAll() 76 | if err != nil { 77 | t.Errorf("failed to flush_all: %v", err) 78 | } 79 | } 80 | 81 | func getFreePort() (port int, err error) { 82 | listener, err := net.Listen("tcp", "127.0.0.1:0") 83 | if err != nil { 84 | return 0, err 85 | } 86 | defer listener.Close() 87 | 88 | addr := listener.Addr().String() 89 | _, portString, err := net.SplitHostPort(addr) 90 | if err != nil { 91 | return 0, err 92 | } 93 | 94 | return strconv.Atoi(portString) 95 | } 96 | 97 | // mock 98 | var memStore sync.Map 99 | 100 | func DefaultGet(ctx context.Context, req *Request, res *Response) error { 101 | for _, key := range req.Keys { 102 | value, _ := memStore.Load(key) 103 | res.Values = append(res.Values, Value{key, "0", value.([]byte), ""}) 104 | } 105 | 106 | res.Response = RespEnd 107 | return nil 108 | } 109 | 110 | func DefaultSet(ctx context.Context, req *Request, res *Response) error { 111 | key := req.Key 112 | value := req.Data 113 | memStore.Store(key, value) 114 | 115 | res.Response = RespStored 116 | return nil 117 | } 118 | 119 | func DefaultDelete(ctx context.Context, req *Request, res *Response) error { 120 | if _, exists := memStore.Load(req.Key); exists { 121 | memStore.Delete(req.Key) 122 | res.Response = RespDeleted 123 | } else { 124 | res.Response = RespNotFound 125 | } 126 | return nil 127 | } 128 | 129 | func DefaultIncr(ctx context.Context, req *Request, res *Response) error { 130 | key := req.Key 131 | increment := req.Value 132 | var base uint64 133 | if value, exists := memStore.Load(key); exists { 134 | var err error 135 | base, err = strconv.ParseUint(string(value.([]byte)), 10, 64) 136 | if err != nil { 137 | return err 138 | } 139 | } 140 | 141 | value := strconv.FormatUint(base+increment, 10) 142 | memStore.Store(key, []byte(value)) 143 | 144 | res.Response = value 145 | return nil 146 | } 147 | 148 | func DefaultFlushAll(ctx context.Context, req *Request, res *Response) error { 149 | memStore = sync.Map{} 150 | res.Response = RespOK 151 | return nil 152 | } 153 | 154 | func DefaultVersion(ctx context.Context, req *Request, res *Response) error { 155 | res.Response = "VERSION 1" 156 | return nil 157 | } 158 | -------------------------------------------------------------------------------- /memcached.go: -------------------------------------------------------------------------------- 1 | package mc 2 | 3 | import ( 4 | "bufio" 5 | "context" 6 | "fmt" 7 | "log" 8 | "net" 9 | "net/url" 10 | "runtime/debug" 11 | "strings" 12 | "sync" 13 | "sync/atomic" 14 | "time" 15 | ) 16 | 17 | const ( 18 | // ReaderBuffsize is used for bufio reader. 19 | ReaderBuffsize = 16 * 1024 20 | // WriterBuffsize is used for bufio writer. 21 | WriterBuffsize = 16 * 1024 22 | ) 23 | 24 | var ( 25 | RespOK = "OK" 26 | RespEnd = "END" 27 | RespStored = "STORED" 28 | RespNotStored = "NOT_STORED" 29 | RespExists = "EXISTS" 30 | RespDeleted = "DELETED" 31 | RespTouched = "TOUCHED" 32 | RespNotFound = "NOT_FOUND" 33 | RespErr = "ERROR " 34 | RespClientErr = "CLIENT_ERROR " 35 | RespServerErr = "SERVER_ERROR " 36 | ) 37 | 38 | // RemoteConnKey is used as key in context. 39 | type RemoteConnKey struct{} 40 | 41 | // HandlerFunc is a function to handle a request and returns a response. 42 | type HandlerFunc func(ctx context.Context, req *Request, res *Response) error 43 | 44 | // Server implements memcached server. 45 | type Server struct { 46 | addr string 47 | ln net.Listener 48 | methods map[string]HandlerFunc // should init this map before working 49 | clients sync.Map 50 | 51 | stopped int32 52 | } 53 | 54 | // NewServer creates a memcached server. 55 | func NewServer(addr string) *Server { 56 | return &Server{ 57 | addr: addr, 58 | methods: make(map[string]HandlerFunc), 59 | } 60 | } 61 | 62 | // Start starts the memcached server in a goroutine. 63 | // It listens on the TCP/unix network address s.Addr and then calls Serve to handle 64 | // requests on incoming connections. Accepted connections are configured to enable 65 | // TCP keep-alives when they are TCP network connections. 66 | func (s *Server) Start() error { 67 | var err error 68 | 69 | if strings.Contains(s.addr, "://") { 70 | var u *url.URL 71 | u, err = url.Parse(s.addr) 72 | if err != nil { 73 | return err 74 | } 75 | 76 | switch u.Scheme { 77 | case "unix": 78 | s.ln, err = net.Listen("unix", u.Path) 79 | default: 80 | s.ln, err = net.Listen("tcp", u.Host) 81 | } 82 | } else { 83 | s.ln, err = net.Listen("tcp", s.addr) 84 | } 85 | 86 | if err != nil { 87 | return err 88 | } 89 | 90 | log.Printf("memcached server starts on %s", s.addr) 91 | go s.Serve(s.ln) 92 | return nil 93 | } 94 | 95 | // Serve accepts incoming connections on the Listener ln, creating a new service goroutine for each. 96 | // The service goroutines read requests and then call registered handlers to reply to them. 97 | func (s *Server) Serve(ln net.Listener) error { 98 | defer ln.Close() 99 | 100 | var tempDelay time.Duration // how long to sleep on accept failure 101 | for { 102 | conn, err := ln.Accept() 103 | if err != nil { 104 | if ne, ok := err.(net.Error); ok && ne.Temporary() { 105 | if tempDelay == 0 { 106 | tempDelay = 5 * time.Millisecond 107 | } else { 108 | tempDelay *= 2 109 | } 110 | if max := 1 * time.Second; tempDelay > max { 111 | tempDelay = max 112 | } 113 | log.Printf("accept error: %v; retrying in %v", err, tempDelay) 114 | time.Sleep(tempDelay) 115 | continue 116 | } 117 | log.Printf("memcached server accept error: %v", err) 118 | return err 119 | } 120 | tempDelay = 0 121 | 122 | if atomic.LoadInt32(&s.stopped) != 0 { 123 | conn.Close() 124 | return nil 125 | } 126 | 127 | if tc, ok := conn.(*net.TCPConn); ok { 128 | tc.SetNoDelay(true) 129 | tc.SetKeepAlive(true) 130 | } 131 | 132 | s.clients.Store(conn, struct{}{}) 133 | 134 | go s.handleConn(conn) 135 | } 136 | } 137 | 138 | // RegisterFunc registers a handler to handle this command. 139 | func (s *Server) RegisterFunc(cmd string, fn HandlerFunc) error { 140 | s.methods[cmd] = fn 141 | return nil 142 | } 143 | 144 | func (s *Server) handleConn(conn net.Conn) { 145 | defer func() { 146 | if err := recover(); err != nil { 147 | fmt.Printf("memcached server panic error: %s, stack: %s", err, string(debug.Stack())) 148 | } 149 | s.clients.Delete(conn) 150 | conn.Close() 151 | }() 152 | 153 | r := bufio.NewReaderSize(conn, ReaderBuffsize) 154 | w := bufio.NewWriterSize(conn, WriterBuffsize) 155 | 156 | ctx := context.Background() 157 | ctx = context.WithValue(ctx, RemoteConnKey{}, conn) 158 | 159 | for atomic.LoadInt32(&s.stopped) == 0 { 160 | req, err := ReadRequest(r) 161 | if perr, ok := err.(Error); ok { 162 | log.Printf("%v ReadRequest protocol err: %v", conn, err) 163 | w.WriteString(RespClientErr + perr.Error() + "\r\n") 164 | w.Flush() 165 | continue 166 | } else if err != nil { 167 | log.Printf("ReadRequest from %s err: %v", conn.RemoteAddr().String(), err) 168 | return 169 | } 170 | 171 | cmd := req.Command 172 | if cmd == "quit" { 173 | log.Printf("client send quit, closed") 174 | return 175 | } 176 | 177 | res := &Response{} 178 | fn, exists := s.methods[cmd] 179 | if exists { 180 | err := fn(ctx, req, res) 181 | if err != nil { 182 | log.Printf("ERROR: %v, Conn: %v, Req: %+v\n", err, conn, req) 183 | res.Response = RespServerErr + err.Error() 184 | } 185 | if !req.Noreply { 186 | w.WriteString(res.String()) 187 | w.Flush() 188 | } 189 | } else { 190 | res.Response = RespErr + cmd + " not implemented'" 191 | w.WriteString(res.String()) 192 | w.Flush() 193 | } 194 | } 195 | } 196 | 197 | // Stop stops this memcached sever. 198 | func (s *Server) Stop() error { 199 | var err error 200 | if !atomic.CompareAndSwapInt32(&s.stopped, 0, 1) { 201 | return nil 202 | } 203 | 204 | if s.ln == nil { 205 | fmt.Println("memcached server has not started") 206 | return nil 207 | } 208 | 209 | if err = s.ln.Close(); err != nil { 210 | fmt.Printf("failed to close listener: %v", err) 211 | } 212 | 213 | //Make on processing commamd to run over 214 | time.Sleep(200 * time.Millisecond) 215 | 216 | s.drainConn() 217 | 218 | // for s.count() != 0 { 219 | // time.Sleep(time.Millisecond) 220 | // } 221 | 222 | checkStart := time.Now() 223 | for { 224 | found := false 225 | s.clients.Range(func(k, v interface{}) bool { 226 | found = true 227 | return false 228 | }) 229 | if found { 230 | time.Sleep(10 * time.Millisecond) 231 | } 232 | // wait at most 1 second 233 | if time.Since(checkStart).Seconds() > 1 { 234 | break 235 | } 236 | } 237 | 238 | fmt.Println("memcached server stop") 239 | return err 240 | } 241 | 242 | // close connection of clients. 243 | func (s *Server) drainConn() { 244 | s.clients.Range(func(k, v interface{}) bool { 245 | k.(net.Conn).Close() 246 | return true 247 | }) 248 | } 249 | -------------------------------------------------------------------------------- /memcache_req.go: -------------------------------------------------------------------------------- 1 | // Package mc implements memcached text protocol: https://github.com/memcached/memcached/blob/master/doc/protocol.txt. 2 | // binary protocol () has not been implemented. 3 | package mc 4 | 5 | import ( 6 | "bufio" 7 | "fmt" 8 | "io" 9 | "strconv" 10 | "strings" 11 | ) 12 | 13 | // RealtimeMaxDelta is max delta time. 14 | const RealtimeMaxDelta = 60 * 60 * 24 * 30 15 | 16 | // Request is a generic memcached request. 17 | // Some fields are meaningless for some special commands and they are zero values. 18 | // Exptime will always be 0 or epoch (in seconds) 19 | type Request struct { 20 | // Command is memcached command name, see https://github.com/memcached/memcached/wiki/Commands 21 | Command string 22 | Key string 23 | Keys []string 24 | Flags string 25 | Exptime int64 // in second 26 | Data []byte 27 | Value uint64 28 | Cas string 29 | Noreply bool 30 | } 31 | 32 | // Error is memcached protocol error. 33 | type Error struct { 34 | Description string 35 | } 36 | 37 | func (e Error) Error() string { 38 | return fmt.Sprintf("MC Protocol error: %s", e.Description) 39 | } 40 | 41 | // NewError creates a new error. 42 | func NewError(description string) Error { 43 | return Error{description} 44 | } 45 | 46 | // ReadRequest reads a request from reader 47 | func ReadRequest(r *bufio.Reader) (req *Request, err error) { 48 | lineBytes, _, err := r.ReadLine() 49 | if err != nil { 50 | return nil, err 51 | } 52 | line := string(lineBytes) 53 | arr := strings.Fields(line) 54 | if len(arr) < 1 { 55 | return nil, NewError("empty line") 56 | } 57 | 58 | switch arr[0] { 59 | case "set", "add", "replace", "append", "prepend": 60 | // format: 61 | // [noreply]\r\n 62 | // \r\n 63 | if len(arr) < 5 { 64 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 65 | } 66 | req := &Request{} 67 | req.Command = arr[0] 68 | req.Key = arr[1] 69 | req.Flags = arr[2] 70 | 71 | // always use epoch 72 | req.Exptime, err = strconv.ParseInt(arr[3], 10, 64) 73 | if err != nil { 74 | return nil, NewError("cannot read exptime " + err.Error()) 75 | } 76 | // if req.Exptime > 0 { 77 | // if req.Exptime <= RealtimeMaxDelta { // <= 30 days 78 | // req.Exptime = time.Now().Unix() + req.Exptime 79 | // } 80 | // } 81 | 82 | bytes, err := strconv.Atoi(arr[4]) 83 | if err != nil { 84 | return nil, NewError("cannot read bytes " + err.Error()) 85 | } 86 | if len(arr) > 5 && arr[5] == "noreply" { 87 | req.Noreply = true 88 | } 89 | req.Data = make([]byte, bytes) 90 | 91 | n, err := io.ReadFull(r, req.Data) 92 | if err != nil { 93 | return nil, err 94 | } 95 | if n != bytes { 96 | return nil, NewError(fmt.Sprintf("Read only %d bytes of %d bytes of expected data", n, bytes)) 97 | } 98 | c, err := r.ReadByte() 99 | if err != nil { 100 | return nil, err 101 | } 102 | if c != '\r' { 103 | return nil, NewError("expected \\r") 104 | } 105 | c, err = r.ReadByte() 106 | if err != nil { 107 | return nil, err 108 | } 109 | if c != '\n' { 110 | return nil, NewError("expected \\n") 111 | } 112 | return req, nil 113 | case "cas": 114 | // format: 115 | // cas [noreply]\r\n 116 | // \r\n 117 | if len(arr) < 6 { 118 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 119 | } 120 | req := &Request{} 121 | req.Command = arr[0] 122 | req.Key = arr[1] 123 | req.Flags = arr[2] 124 | 125 | req.Exptime, err = strconv.ParseInt(arr[3], 10, 64) 126 | if err != nil { 127 | return nil, NewError("cannot read exptime " + err.Error()) 128 | } 129 | // if req.Exptime > 0 { 130 | // if req.Exptime <= RealtimeMaxDelta { // <= 30 days 131 | // req.Exptime = time.Now().Unix() + req.Exptime 132 | // } 133 | // } 134 | 135 | bytes, err := strconv.Atoi(arr[4]) 136 | if err != nil { 137 | return nil, err 138 | } 139 | req.Cas = arr[5] 140 | if len(arr) > 6 && arr[6] == "noreply" { 141 | req.Noreply = true 142 | } 143 | req.Data = make([]byte, bytes) 144 | n, err := io.ReadFull(r, req.Data) 145 | if err != nil { 146 | return nil, err 147 | } 148 | if n != bytes { 149 | return nil, NewError(fmt.Sprintf("Read only %d bytes of %d bytes of expected data", n, bytes)) 150 | } 151 | c, err := r.ReadByte() 152 | if err != nil { 153 | return nil, err 154 | } 155 | if c != '\r' { 156 | return nil, NewError("expected \\r") 157 | } 158 | c, err = r.ReadByte() 159 | if err != nil { 160 | return nil, err 161 | } 162 | if c != '\n' { 163 | return nil, NewError("expected \\n") 164 | } 165 | return req, nil 166 | case "delete": 167 | // format: 168 | // delete [noreply]\r\n 169 | if len(arr) < 2 { 170 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 171 | } 172 | req := &Request{} 173 | req.Command = arr[0] 174 | req.Key = arr[1] 175 | 176 | if len(arr) > 2 && arr[2] == "noreply" { 177 | req.Noreply = true 178 | } 179 | return req, nil 180 | case "get", "gets": 181 | // format: 182 | // get *\r\n 183 | // gets *\r\n 184 | if len(arr) < 2 { 185 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 186 | } 187 | req := &Request{} 188 | req.Command = arr[0] 189 | req.Keys = arr[1:] 190 | return req, nil 191 | case "incr", "decr": 192 | // format: 193 | // incr [noreply]\r\n 194 | // decr [noreply]\r\n 195 | if len(arr) < 3 { 196 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 197 | } 198 | req := &Request{} 199 | req.Command = arr[0] 200 | req.Key = arr[1] 201 | 202 | req.Value, err = strconv.ParseUint(arr[2], 10, 64) 203 | if err != nil { 204 | return nil, NewError("cannot read value " + err.Error()) 205 | } 206 | 207 | if len(arr) > 3 && arr[3] == "noreply" { 208 | req.Noreply = true 209 | } 210 | return req, nil 211 | case "touch": 212 | // format: 213 | // touch [noreply]\r\n 214 | if len(arr) < 3 { 215 | return nil, NewError(fmt.Sprintf("too few params to command %q", arr[0])) 216 | } 217 | req := &Request{} 218 | req.Command = arr[0] 219 | req.Key = arr[1] 220 | 221 | req.Exptime, err = strconv.ParseInt(arr[2], 10, 64) 222 | if err != nil { 223 | return nil, NewError("cannot read exptime " + err.Error()) 224 | } 225 | // if req.Exptime > 0 { 226 | // if req.Exptime <= RealtimeMaxDelta { // <= 30 days 227 | // req.Exptime = time.Now().Unix() + req.Exptime 228 | // } 229 | // } 230 | 231 | if len(arr) > 3 && arr[3] == "noreply" { 232 | req.Noreply = true 233 | } 234 | return req, nil 235 | case "flush_all": 236 | // flush_all [delay]\r\n 237 | req := &Request{Command: arr[0]} 238 | 239 | if len(arr) > 1 { 240 | req.Exptime, err = strconv.ParseInt(arr[1], 10, 64) 241 | if err != nil { 242 | return nil, NewError("cannot read delay " + err.Error()) 243 | } 244 | } 245 | 246 | return req, nil 247 | case "version", "quit": 248 | // version\r\n 249 | // quit\r\n 250 | return &Request{Command: arr[0]}, nil 251 | case "stats": 252 | // stats\r\n 253 | // stats \r\n 254 | req := &Request{Command: arr[0]} 255 | if len(arr) > 1 { 256 | req.Keys = arr[1:] 257 | } 258 | return req, nil 259 | } 260 | return nil, NewError(fmt.Sprintf("unknown command %q", arr[0])) 261 | } 262 | --------------------------------------------------------------------------------