protocol.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909
  1. // Copyright (C) 2014 The Protocol Authors.
  2. package protocol
  3. import (
  4. "crypto/sha256"
  5. "encoding/binary"
  6. "errors"
  7. "fmt"
  8. "io"
  9. "path"
  10. "strings"
  11. "sync"
  12. "time"
  13. lz4 "github.com/bkaradzic/go-lz4"
  14. )
  15. const (
  16. // Shifts
  17. KiB = 10
  18. MiB = 20
  19. GiB = 30
  20. )
  21. const (
  22. // MaxMessageLen is the largest message size allowed on the wire. (500 MB)
  23. MaxMessageLen = 500 * 1000 * 1000
  24. // MinBlockSize is the minimum block size allowed
  25. MinBlockSize = 128 << KiB
  26. // MaxBlockSize is the maximum block size allowed
  27. MaxBlockSize = 16 << MiB
  28. // DesiredPerFileBlocks is the number of blocks we aim for per file
  29. DesiredPerFileBlocks = 2000
  30. )
  31. // BlockSizes is the list of valid block sizes, from min to max
  32. var BlockSizes []int
  33. // For each block size, the hash of a block of all zeroes
  34. var sha256OfEmptyBlock = make(map[int][sha256.Size]byte)
  35. func init() {
  36. for blockSize := MinBlockSize; blockSize <= MaxBlockSize; blockSize *= 2 {
  37. BlockSizes = append(BlockSizes, blockSize)
  38. sha256OfEmptyBlock[blockSize] = sha256.Sum256(make([]byte, blockSize))
  39. }
  40. }
  41. // BlockSize returns the block size to use for the given file size
  42. func BlockSize(fileSize int64) int {
  43. var blockSize int
  44. for _, blockSize = range BlockSizes {
  45. if fileSize < int64(DesiredPerFileBlocks*blockSize) {
  46. break
  47. }
  48. }
  49. return blockSize
  50. }
  51. const (
  52. stateInitial = iota
  53. stateReady
  54. )
  55. // Request message flags
  56. const (
  57. FlagFromTemporary uint32 = 1 << iota
  58. )
  59. // ClusterConfigMessage.Folders flags
  60. const (
  61. FlagFolderReadOnly uint32 = 1 << 0
  62. FlagFolderIgnorePerms = 1 << 1
  63. FlagFolderIgnoreDelete = 1 << 2
  64. FlagFolderDisabledTempIndexes = 1 << 3
  65. FlagFolderAll = 1<<4 - 1
  66. )
  67. // ClusterConfigMessage.Folders.Devices flags
  68. const (
  69. FlagShareTrusted uint32 = 1 << 0
  70. FlagShareReadOnly = 1 << 1
  71. FlagIntroducer = 1 << 2
  72. FlagShareBits = 0x000000ff
  73. )
  74. var (
  75. ErrClosed = errors.New("connection closed")
  76. ErrTimeout = errors.New("read timeout")
  77. ErrSwitchingConnections = errors.New("switching connections")
  78. errUnknownMessage = errors.New("unknown message")
  79. errInvalidFilename = errors.New("filename is invalid")
  80. errUncleanFilename = errors.New("filename not in canonical format")
  81. errDeletedHasBlocks = errors.New("deleted file with non-empty block list")
  82. errDirectoryHasBlocks = errors.New("directory with non-empty block list")
  83. errFileHasNoBlocks = errors.New("file with empty block list")
  84. )
  85. type Model interface {
  86. // An index was received from the peer device
  87. Index(deviceID DeviceID, folder string, files []FileInfo)
  88. // An index update was received from the peer device
  89. IndexUpdate(deviceID DeviceID, folder string, files []FileInfo)
  90. // A request was made by the peer device
  91. Request(deviceID DeviceID, folder string, name string, offset int64, hash []byte, weakHash uint32, fromTemporary bool, buf []byte) error
  92. // A cluster configuration message was received
  93. ClusterConfig(deviceID DeviceID, config ClusterConfig)
  94. // The peer device closed the connection
  95. Closed(conn Connection, err error)
  96. // The peer device sent progress updates for the files it is currently downloading
  97. DownloadProgress(deviceID DeviceID, folder string, updates []FileDownloadProgressUpdate)
  98. }
  99. type Connection interface {
  100. Start()
  101. ID() DeviceID
  102. Name() string
  103. Index(folder string, files []FileInfo) error
  104. IndexUpdate(folder string, files []FileInfo) error
  105. Request(folder string, name string, offset int64, size int, hash []byte, weakHash uint32, fromTemporary bool) ([]byte, error)
  106. ClusterConfig(config ClusterConfig)
  107. DownloadProgress(folder string, updates []FileDownloadProgressUpdate)
  108. Statistics() Statistics
  109. Closed() bool
  110. }
  111. type rawConnection struct {
  112. id DeviceID
  113. name string
  114. receiver Model
  115. cr *countingReader
  116. cw *countingWriter
  117. awaiting map[int32]chan asyncResult
  118. awaitingMut sync.Mutex
  119. idxMut sync.Mutex // ensures serialization of Index calls
  120. nextID int32
  121. nextIDMut sync.Mutex
  122. outbox chan asyncMessage
  123. closed chan struct{}
  124. once sync.Once
  125. pool bufferPool
  126. compression Compression
  127. }
  128. type asyncResult struct {
  129. val []byte
  130. err error
  131. }
  132. type message interface {
  133. ProtoSize() int
  134. Marshal() ([]byte, error)
  135. MarshalTo([]byte) (int, error)
  136. Unmarshal([]byte) error
  137. }
  138. type asyncMessage struct {
  139. msg message
  140. done chan struct{} // done closes when we're done marshalling the message and its contents can be reused
  141. }
  142. const (
  143. // PingSendInterval is how often we make sure to send a message, by
  144. // triggering pings if necessary.
  145. PingSendInterval = 90 * time.Second
  146. // ReceiveTimeout is the longest we'll wait for a message from the other
  147. // side before closing the connection.
  148. ReceiveTimeout = 300 * time.Second
  149. )
  150. // A buffer pool for global use. We don't allocate smaller buffers than 64k,
  151. // in the hope of being able to reuse them later.
  152. var buffers = bufferPool{
  153. minSize: 64 << 10,
  154. }
  155. func NewConnection(deviceID DeviceID, reader io.Reader, writer io.Writer, receiver Model, name string, compress Compression) Connection {
  156. cr := &countingReader{Reader: reader}
  157. cw := &countingWriter{Writer: writer}
  158. c := rawConnection{
  159. id: deviceID,
  160. name: name,
  161. receiver: nativeModel{receiver},
  162. cr: cr,
  163. cw: cw,
  164. awaiting: make(map[int32]chan asyncResult),
  165. outbox: make(chan asyncMessage),
  166. closed: make(chan struct{}),
  167. pool: bufferPool{minSize: MinBlockSize},
  168. compression: compress,
  169. }
  170. return wireFormatConnection{&c}
  171. }
  172. // Start creates the goroutines for sending and receiving of messages. It must
  173. // be called exactly once after creating a connection.
  174. func (c *rawConnection) Start() {
  175. go c.readerLoop()
  176. go c.writerLoop()
  177. go c.pingSender()
  178. go c.pingReceiver()
  179. }
  180. func (c *rawConnection) ID() DeviceID {
  181. return c.id
  182. }
  183. func (c *rawConnection) Name() string {
  184. return c.name
  185. }
  186. // Index writes the list of file information to the connected peer device
  187. func (c *rawConnection) Index(folder string, idx []FileInfo) error {
  188. select {
  189. case <-c.closed:
  190. return ErrClosed
  191. default:
  192. }
  193. c.idxMut.Lock()
  194. c.send(&Index{
  195. Folder: folder,
  196. Files: idx,
  197. }, nil)
  198. c.idxMut.Unlock()
  199. return nil
  200. }
  201. // IndexUpdate writes the list of file information to the connected peer device as an update
  202. func (c *rawConnection) IndexUpdate(folder string, idx []FileInfo) error {
  203. select {
  204. case <-c.closed:
  205. return ErrClosed
  206. default:
  207. }
  208. c.idxMut.Lock()
  209. c.send(&IndexUpdate{
  210. Folder: folder,
  211. Files: idx,
  212. }, nil)
  213. c.idxMut.Unlock()
  214. return nil
  215. }
  216. // Request returns the bytes for the specified block after fetching them from the connected peer.
  217. func (c *rawConnection) Request(folder string, name string, offset int64, size int, hash []byte, weakHash uint32, fromTemporary bool) ([]byte, error) {
  218. c.nextIDMut.Lock()
  219. id := c.nextID
  220. c.nextID++
  221. c.nextIDMut.Unlock()
  222. c.awaitingMut.Lock()
  223. if _, ok := c.awaiting[id]; ok {
  224. panic("id taken")
  225. }
  226. rc := make(chan asyncResult, 1)
  227. c.awaiting[id] = rc
  228. c.awaitingMut.Unlock()
  229. ok := c.send(&Request{
  230. ID: id,
  231. Folder: folder,
  232. Name: name,
  233. Offset: offset,
  234. Size: int32(size),
  235. Hash: hash,
  236. WeakHash: weakHash,
  237. FromTemporary: fromTemporary,
  238. }, nil)
  239. if !ok {
  240. return nil, ErrClosed
  241. }
  242. res, ok := <-rc
  243. if !ok {
  244. return nil, ErrClosed
  245. }
  246. return res.val, res.err
  247. }
  248. // ClusterConfig send the cluster configuration message to the peer and returns any error
  249. func (c *rawConnection) ClusterConfig(config ClusterConfig) {
  250. c.send(&config, nil)
  251. }
  252. func (c *rawConnection) Closed() bool {
  253. select {
  254. case <-c.closed:
  255. return true
  256. default:
  257. return false
  258. }
  259. }
  260. // DownloadProgress sends the progress updates for the files that are currently being downloaded.
  261. func (c *rawConnection) DownloadProgress(folder string, updates []FileDownloadProgressUpdate) {
  262. c.send(&DownloadProgress{
  263. Folder: folder,
  264. Updates: updates,
  265. }, nil)
  266. }
  267. func (c *rawConnection) ping() bool {
  268. return c.send(&Ping{}, nil)
  269. }
  270. func (c *rawConnection) readerLoop() (err error) {
  271. defer func() {
  272. c.close(err)
  273. }()
  274. state := stateInitial
  275. for {
  276. select {
  277. case <-c.closed:
  278. return ErrClosed
  279. default:
  280. }
  281. msg, err := c.readMessage()
  282. if err == errUnknownMessage {
  283. // Unknown message types are skipped, for future extensibility.
  284. continue
  285. }
  286. if err != nil {
  287. return err
  288. }
  289. switch msg := msg.(type) {
  290. case *ClusterConfig:
  291. l.Debugln("read ClusterConfig message")
  292. if state != stateInitial {
  293. return fmt.Errorf("protocol error: cluster config message in state %d", state)
  294. }
  295. c.receiver.ClusterConfig(c.id, *msg)
  296. state = stateReady
  297. case *Index:
  298. l.Debugln("read Index message")
  299. if state != stateReady {
  300. return fmt.Errorf("protocol error: index message in state %d", state)
  301. }
  302. if err := checkIndexConsistency(msg.Files); err != nil {
  303. return fmt.Errorf("protocol error: index: %v", err)
  304. }
  305. c.handleIndex(*msg)
  306. state = stateReady
  307. case *IndexUpdate:
  308. l.Debugln("read IndexUpdate message")
  309. if state != stateReady {
  310. return fmt.Errorf("protocol error: index update message in state %d", state)
  311. }
  312. if err := checkIndexConsistency(msg.Files); err != nil {
  313. return fmt.Errorf("protocol error: index update: %v", err)
  314. }
  315. c.handleIndexUpdate(*msg)
  316. state = stateReady
  317. case *Request:
  318. l.Debugln("read Request message")
  319. if state != stateReady {
  320. return fmt.Errorf("protocol error: request message in state %d", state)
  321. }
  322. if err := checkFilename(msg.Name); err != nil {
  323. return fmt.Errorf("protocol error: request: %q: %v", msg.Name, err)
  324. }
  325. // Requests are handled asynchronously
  326. go c.handleRequest(*msg)
  327. case *Response:
  328. l.Debugln("read Response message")
  329. if state != stateReady {
  330. return fmt.Errorf("protocol error: response message in state %d", state)
  331. }
  332. c.handleResponse(*msg)
  333. case *DownloadProgress:
  334. l.Debugln("read DownloadProgress message")
  335. if state != stateReady {
  336. return fmt.Errorf("protocol error: response message in state %d", state)
  337. }
  338. c.receiver.DownloadProgress(c.id, msg.Folder, msg.Updates)
  339. case *Ping:
  340. l.Debugln("read Ping message")
  341. if state != stateReady {
  342. return fmt.Errorf("protocol error: ping message in state %d", state)
  343. }
  344. // Nothing
  345. case *Close:
  346. l.Debugln("read Close message")
  347. return errors.New(msg.Reason)
  348. default:
  349. l.Debugf("read unknown message: %+T", msg)
  350. return fmt.Errorf("protocol error: %s: unknown or empty message", c.id)
  351. }
  352. }
  353. }
  354. func (c *rawConnection) readMessage() (message, error) {
  355. hdr, err := c.readHeader()
  356. if err != nil {
  357. return nil, err
  358. }
  359. return c.readMessageAfterHeader(hdr)
  360. }
  361. func (c *rawConnection) readMessageAfterHeader(hdr Header) (message, error) {
  362. // First comes a 4 byte message length
  363. buf := buffers.get(4)
  364. if _, err := io.ReadFull(c.cr, buf); err != nil {
  365. return nil, fmt.Errorf("reading message length: %v", err)
  366. }
  367. msgLen := int32(binary.BigEndian.Uint32(buf))
  368. if msgLen < 0 {
  369. return nil, fmt.Errorf("negative message length %d", msgLen)
  370. }
  371. // Then comes the message
  372. buf = buffers.upgrade(buf, int(msgLen))
  373. if _, err := io.ReadFull(c.cr, buf); err != nil {
  374. return nil, fmt.Errorf("reading message: %v", err)
  375. }
  376. // ... which might be compressed
  377. switch hdr.Compression {
  378. case MessageCompressionNone:
  379. // Nothing
  380. case MessageCompressionLZ4:
  381. decomp, err := c.lz4Decompress(buf)
  382. buffers.put(buf)
  383. if err != nil {
  384. return nil, fmt.Errorf("decompressing message: %v", err)
  385. }
  386. buf = decomp
  387. default:
  388. return nil, fmt.Errorf("unknown message compression %d", hdr.Compression)
  389. }
  390. // ... and is then unmarshalled
  391. msg, err := c.newMessage(hdr.Type)
  392. if err != nil {
  393. return nil, err
  394. }
  395. if err := msg.Unmarshal(buf); err != nil {
  396. return nil, fmt.Errorf("unmarshalling message: %v", err)
  397. }
  398. buffers.put(buf)
  399. return msg, nil
  400. }
  401. func (c *rawConnection) readHeader() (Header, error) {
  402. // First comes a 2 byte header length
  403. buf := buffers.get(2)
  404. if _, err := io.ReadFull(c.cr, buf); err != nil {
  405. return Header{}, fmt.Errorf("reading length: %v", err)
  406. }
  407. hdrLen := int16(binary.BigEndian.Uint16(buf))
  408. if hdrLen < 0 {
  409. return Header{}, fmt.Errorf("negative header length %d", hdrLen)
  410. }
  411. // Then comes the header
  412. buf = buffers.upgrade(buf, int(hdrLen))
  413. if _, err := io.ReadFull(c.cr, buf); err != nil {
  414. return Header{}, fmt.Errorf("reading header: %v", err)
  415. }
  416. var hdr Header
  417. if err := hdr.Unmarshal(buf); err != nil {
  418. return Header{}, fmt.Errorf("unmarshalling header: %v", err)
  419. }
  420. buffers.put(buf)
  421. return hdr, nil
  422. }
  423. func (c *rawConnection) handleIndex(im Index) {
  424. l.Debugf("Index(%v, %v, %d file)", c.id, im.Folder, len(im.Files))
  425. c.receiver.Index(c.id, im.Folder, im.Files)
  426. }
  427. func (c *rawConnection) handleIndexUpdate(im IndexUpdate) {
  428. l.Debugf("queueing IndexUpdate(%v, %v, %d files)", c.id, im.Folder, len(im.Files))
  429. c.receiver.IndexUpdate(c.id, im.Folder, im.Files)
  430. }
  431. // checkIndexConsistency verifies a number of invariants on FileInfos received in
  432. // index messages.
  433. func checkIndexConsistency(fs []FileInfo) error {
  434. for _, f := range fs {
  435. if err := checkFileInfoConsistency(f); err != nil {
  436. return fmt.Errorf("%q: %v", f.Name, err)
  437. }
  438. }
  439. return nil
  440. }
  441. // checkFileInfoConsistency verifies a number of invariants on the given FileInfo
  442. func checkFileInfoConsistency(f FileInfo) error {
  443. if err := checkFilename(f.Name); err != nil {
  444. return err
  445. }
  446. switch {
  447. case f.Deleted && len(f.Blocks) != 0:
  448. // Deleted files should have no blocks
  449. return errDeletedHasBlocks
  450. case f.Type == FileInfoTypeDirectory && len(f.Blocks) != 0:
  451. // Directories should have no blocks
  452. return errDirectoryHasBlocks
  453. case !f.Deleted && !f.Invalid && f.Type == FileInfoTypeFile && len(f.Blocks) == 0:
  454. // Non-deleted, non-invalid files should have at least one block
  455. return errFileHasNoBlocks
  456. }
  457. return nil
  458. }
  459. // checkFilename verifies that the given filename is valid according to the
  460. // spec on what's allowed over the wire. A filename failing this test is
  461. // grounds for disconnecting the device.
  462. func checkFilename(name string) error {
  463. cleanedName := path.Clean(name)
  464. if cleanedName != name {
  465. // The filename on the wire should be in canonical format. If
  466. // Clean() managed to clean it up, there was something wrong with
  467. // it.
  468. return errUncleanFilename
  469. }
  470. switch name {
  471. case "", ".", "..":
  472. // These names are always invalid.
  473. return errInvalidFilename
  474. }
  475. if strings.HasPrefix(name, "/") {
  476. // Names are folder relative, not absolute.
  477. return errInvalidFilename
  478. }
  479. if strings.HasPrefix(name, "../") {
  480. // Starting with a dotdot is not allowed. Any other dotdots would
  481. // have been handled by the Clean() call at the top.
  482. return errInvalidFilename
  483. }
  484. return nil
  485. }
  486. func (c *rawConnection) handleRequest(req Request) {
  487. size := int(req.Size)
  488. usePool := size <= MaxBlockSize
  489. var buf []byte
  490. var done chan struct{}
  491. if usePool {
  492. buf = c.pool.get(size)
  493. done = make(chan struct{})
  494. } else {
  495. buf = make([]byte, size)
  496. }
  497. err := c.receiver.Request(c.id, req.Folder, req.Name, req.Offset, req.Hash, req.WeakHash, req.FromTemporary, buf)
  498. if err != nil {
  499. c.send(&Response{
  500. ID: req.ID,
  501. Data: nil,
  502. Code: errorToCode(err),
  503. }, done)
  504. } else {
  505. c.send(&Response{
  506. ID: req.ID,
  507. Data: buf,
  508. Code: errorToCode(err),
  509. }, done)
  510. }
  511. if usePool {
  512. <-done
  513. c.pool.put(buf)
  514. }
  515. }
  516. func (c *rawConnection) handleResponse(resp Response) {
  517. c.awaitingMut.Lock()
  518. if rc := c.awaiting[resp.ID]; rc != nil {
  519. delete(c.awaiting, resp.ID)
  520. rc <- asyncResult{resp.Data, codeToError(resp.Code)}
  521. close(rc)
  522. }
  523. c.awaitingMut.Unlock()
  524. }
  525. func (c *rawConnection) send(msg message, done chan struct{}) bool {
  526. select {
  527. case c.outbox <- asyncMessage{msg, done}:
  528. return true
  529. case <-c.closed:
  530. return false
  531. }
  532. }
  533. func (c *rawConnection) writerLoop() {
  534. for {
  535. select {
  536. case hm := <-c.outbox:
  537. if err := c.writeMessage(hm); err != nil {
  538. c.close(err)
  539. return
  540. }
  541. case <-c.closed:
  542. return
  543. }
  544. }
  545. }
  546. func (c *rawConnection) writeMessage(hm asyncMessage) error {
  547. if c.shouldCompressMessage(hm.msg) {
  548. return c.writeCompressedMessage(hm)
  549. }
  550. return c.writeUncompressedMessage(hm)
  551. }
  552. func (c *rawConnection) writeCompressedMessage(hm asyncMessage) error {
  553. size := hm.msg.ProtoSize()
  554. buf := buffers.get(size)
  555. if _, err := hm.msg.MarshalTo(buf); err != nil {
  556. return fmt.Errorf("marshalling message: %v", err)
  557. }
  558. if hm.done != nil {
  559. close(hm.done)
  560. }
  561. compressed, err := c.lz4Compress(buf)
  562. if err != nil {
  563. return fmt.Errorf("compressing message: %v", err)
  564. }
  565. hdr := Header{
  566. Type: c.typeOf(hm.msg),
  567. Compression: MessageCompressionLZ4,
  568. }
  569. hdrSize := hdr.ProtoSize()
  570. if hdrSize > 1<<16-1 {
  571. panic("impossibly large header")
  572. }
  573. totSize := 2 + hdrSize + 4 + len(compressed)
  574. buf = buffers.upgrade(buf, totSize)
  575. // Header length
  576. binary.BigEndian.PutUint16(buf, uint16(hdrSize))
  577. // Header
  578. if _, err := hdr.MarshalTo(buf[2:]); err != nil {
  579. return fmt.Errorf("marshalling header: %v", err)
  580. }
  581. // Message length
  582. binary.BigEndian.PutUint32(buf[2+hdrSize:], uint32(len(compressed)))
  583. // Message
  584. copy(buf[2+hdrSize+4:], compressed)
  585. buffers.put(compressed)
  586. n, err := c.cw.Write(buf)
  587. buffers.put(buf)
  588. l.Debugf("wrote %d bytes on the wire (2 bytes length, %d bytes header, 4 bytes message length, %d bytes message (%d uncompressed)), err=%v", n, hdrSize, len(compressed), size, err)
  589. if err != nil {
  590. return fmt.Errorf("writing message: %v", err)
  591. }
  592. return nil
  593. }
  594. func (c *rawConnection) writeUncompressedMessage(hm asyncMessage) error {
  595. size := hm.msg.ProtoSize()
  596. hdr := Header{
  597. Type: c.typeOf(hm.msg),
  598. }
  599. hdrSize := hdr.ProtoSize()
  600. if hdrSize > 1<<16-1 {
  601. panic("impossibly large header")
  602. }
  603. totSize := 2 + hdrSize + 4 + size
  604. buf := buffers.get(totSize)
  605. // Header length
  606. binary.BigEndian.PutUint16(buf, uint16(hdrSize))
  607. // Header
  608. if _, err := hdr.MarshalTo(buf[2:]); err != nil {
  609. return fmt.Errorf("marshalling header: %v", err)
  610. }
  611. // Message length
  612. binary.BigEndian.PutUint32(buf[2+hdrSize:], uint32(size))
  613. // Message
  614. if _, err := hm.msg.MarshalTo(buf[2+hdrSize+4:]); err != nil {
  615. return fmt.Errorf("marshalling message: %v", err)
  616. }
  617. if hm.done != nil {
  618. close(hm.done)
  619. }
  620. n, err := c.cw.Write(buf[:totSize])
  621. buffers.put(buf)
  622. l.Debugf("wrote %d bytes on the wire (2 bytes length, %d bytes header, 4 bytes message length, %d bytes message), err=%v", n, hdrSize, size, err)
  623. if err != nil {
  624. return fmt.Errorf("writing message: %v", err)
  625. }
  626. return nil
  627. }
  628. func (c *rawConnection) typeOf(msg message) MessageType {
  629. switch msg.(type) {
  630. case *ClusterConfig:
  631. return messageTypeClusterConfig
  632. case *Index:
  633. return messageTypeIndex
  634. case *IndexUpdate:
  635. return messageTypeIndexUpdate
  636. case *Request:
  637. return messageTypeRequest
  638. case *Response:
  639. return messageTypeResponse
  640. case *DownloadProgress:
  641. return messageTypeDownloadProgress
  642. case *Ping:
  643. return messageTypePing
  644. case *Close:
  645. return messageTypeClose
  646. default:
  647. panic("bug: unknown message type")
  648. }
  649. }
  650. func (c *rawConnection) newMessage(t MessageType) (message, error) {
  651. switch t {
  652. case messageTypeClusterConfig:
  653. return new(ClusterConfig), nil
  654. case messageTypeIndex:
  655. return new(Index), nil
  656. case messageTypeIndexUpdate:
  657. return new(IndexUpdate), nil
  658. case messageTypeRequest:
  659. return new(Request), nil
  660. case messageTypeResponse:
  661. return new(Response), nil
  662. case messageTypeDownloadProgress:
  663. return new(DownloadProgress), nil
  664. case messageTypePing:
  665. return new(Ping), nil
  666. case messageTypeClose:
  667. return new(Close), nil
  668. default:
  669. return nil, errUnknownMessage
  670. }
  671. }
  672. func (c *rawConnection) shouldCompressMessage(msg message) bool {
  673. switch c.compression {
  674. case CompressNever:
  675. return false
  676. case CompressAlways:
  677. // Use compression for large enough messages
  678. return msg.ProtoSize() >= compressionThreshold
  679. case CompressMetadata:
  680. _, isResponse := msg.(*Response)
  681. // Compress if it's large enough and not a response message
  682. return !isResponse && msg.ProtoSize() >= compressionThreshold
  683. default:
  684. panic("unknown compression setting")
  685. }
  686. }
  687. func (c *rawConnection) close(err error) {
  688. c.once.Do(func() {
  689. l.Debugln("close due to", err)
  690. close(c.closed)
  691. c.awaitingMut.Lock()
  692. for i, ch := range c.awaiting {
  693. if ch != nil {
  694. close(ch)
  695. delete(c.awaiting, i)
  696. }
  697. }
  698. c.awaitingMut.Unlock()
  699. c.receiver.Closed(c, err)
  700. })
  701. }
  702. // The pingSender makes sure that we've sent a message within the last
  703. // PingSendInterval. If we already have something sent in the last
  704. // PingSendInterval/2, we do nothing. Otherwise we send a ping message. This
  705. // results in an effecting ping interval of somewhere between
  706. // PingSendInterval/2 and PingSendInterval.
  707. func (c *rawConnection) pingSender() {
  708. ticker := time.NewTicker(PingSendInterval / 2)
  709. defer ticker.Stop()
  710. for {
  711. select {
  712. case <-ticker.C:
  713. d := time.Since(c.cw.Last())
  714. if d < PingSendInterval/2 {
  715. l.Debugln(c.id, "ping skipped after wr", d)
  716. continue
  717. }
  718. l.Debugln(c.id, "ping -> after", d)
  719. c.ping()
  720. case <-c.closed:
  721. return
  722. }
  723. }
  724. }
  725. // The pingReceiver checks that we've received a message (any message will do,
  726. // but we expect pings in the absence of other messages) within the last
  727. // ReceiveTimeout. If not, we close the connection with an ErrTimeout.
  728. func (c *rawConnection) pingReceiver() {
  729. ticker := time.NewTicker(ReceiveTimeout / 2)
  730. defer ticker.Stop()
  731. for {
  732. select {
  733. case <-ticker.C:
  734. d := time.Since(c.cr.Last())
  735. if d > ReceiveTimeout {
  736. l.Debugln(c.id, "ping timeout", d)
  737. c.close(ErrTimeout)
  738. }
  739. l.Debugln(c.id, "last read within", d)
  740. case <-c.closed:
  741. return
  742. }
  743. }
  744. }
  745. type Statistics struct {
  746. At time.Time
  747. InBytesTotal int64
  748. OutBytesTotal int64
  749. }
  750. func (c *rawConnection) Statistics() Statistics {
  751. return Statistics{
  752. At: time.Now(),
  753. InBytesTotal: c.cr.Tot(),
  754. OutBytesTotal: c.cw.Tot(),
  755. }
  756. }
  757. func (c *rawConnection) lz4Compress(src []byte) ([]byte, error) {
  758. var err error
  759. buf := buffers.get(len(src))
  760. buf, err = lz4.Encode(buf, src)
  761. if err != nil {
  762. return nil, err
  763. }
  764. binary.BigEndian.PutUint32(buf, binary.LittleEndian.Uint32(buf))
  765. return buf, nil
  766. }
  767. func (c *rawConnection) lz4Decompress(src []byte) ([]byte, error) {
  768. size := binary.BigEndian.Uint32(src)
  769. binary.LittleEndian.PutUint32(src, size)
  770. var err error
  771. buf := buffers.get(int(size))
  772. buf, err = lz4.Decode(buf, src)
  773. if err != nil {
  774. return nil, err
  775. }
  776. return buf, nil
  777. }