packets.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146
  1. // Go MySQL Driver - A MySQL-Driver for Go's database/sql package
  2. //
  3. // Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
  4. //
  5. // This Source Code Form is subject to the terms of the Mozilla Public
  6. // License, v. 2.0. If a copy of the MPL was not distributed with this file,
  7. // You can obtain one at http://mozilla.org/MPL/2.0/.
  8. package mysql
  9. import (
  10. "bytes"
  11. "crypto/tls"
  12. "database/sql/driver"
  13. "encoding/binary"
  14. "fmt"
  15. "io"
  16. "math"
  17. "time"
  18. )
  19. // Packets documentation:
  20. // http://dev.mysql.com/doc/internals/en/client-server-protocol.html
  21. // Read packet to buffer 'data'
  22. func (mc *mysqlConn) readPacket() ([]byte, error) {
  23. // Read packet header
  24. data, err := mc.buf.readNext(4)
  25. if err != nil {
  26. errLog.Print(err.Error())
  27. mc.Close()
  28. return nil, driver.ErrBadConn
  29. }
  30. // Packet Length [24 bit]
  31. pktLen := int(uint32(data[0]) | uint32(data[1])<<8 | uint32(data[2])<<16)
  32. if pktLen < 1 {
  33. errLog.Print(errMalformPkt.Error())
  34. mc.Close()
  35. return nil, driver.ErrBadConn
  36. }
  37. // Check Packet Sync [8 bit]
  38. if data[3] != mc.sequence {
  39. if data[3] > mc.sequence {
  40. return nil, errPktSyncMul
  41. } else {
  42. return nil, errPktSync
  43. }
  44. }
  45. mc.sequence++
  46. // Read packet body [pktLen bytes]
  47. if data, err = mc.buf.readNext(pktLen); err == nil {
  48. if pktLen < maxPacketSize {
  49. return data, nil
  50. }
  51. // Make a copy since data becomes invalid with the next read
  52. buf := make([]byte, len(data))
  53. copy(buf, data)
  54. // More data
  55. data, err = mc.readPacket()
  56. if err == nil {
  57. return append(buf, data...), nil
  58. }
  59. }
  60. // err case
  61. mc.Close()
  62. errLog.Print(err.Error())
  63. return nil, driver.ErrBadConn
  64. }
  65. // Write packet buffer 'data'
  66. // The packet header must be already included
  67. func (mc *mysqlConn) writePacket(data []byte) error {
  68. pktLen := len(data) - 4
  69. if pktLen > mc.maxPacketAllowed {
  70. return errPktTooLarge
  71. }
  72. for {
  73. var size int
  74. if pktLen >= maxPacketSize {
  75. data[0] = 0xff
  76. data[1] = 0xff
  77. data[2] = 0xff
  78. size = maxPacketSize
  79. } else {
  80. data[0] = byte(pktLen)
  81. data[1] = byte(pktLen >> 8)
  82. data[2] = byte(pktLen >> 16)
  83. size = pktLen
  84. }
  85. data[3] = mc.sequence
  86. // Write packet
  87. n, err := mc.netConn.Write(data[:4+size])
  88. if err == nil && n == 4+size {
  89. mc.sequence++
  90. if size != maxPacketSize {
  91. break
  92. }
  93. pktLen -= size
  94. data = data[size:]
  95. continue
  96. }
  97. // Handle error
  98. if err == nil { // n != len(data)
  99. errLog.Print(errMalformPkt.Error())
  100. } else {
  101. errLog.Print(err.Error())
  102. }
  103. return driver.ErrBadConn
  104. }
  105. return nil
  106. }
  107. /******************************************************************************
  108. * Initialisation Process *
  109. ******************************************************************************/
  110. // Handshake Initialization Packet
  111. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::Handshake
  112. func (mc *mysqlConn) readInitPacket() ([]byte, error) {
  113. data, err := mc.readPacket()
  114. if err != nil {
  115. return nil, err
  116. }
  117. if data[0] == iERR {
  118. return nil, mc.handleErrorPacket(data)
  119. }
  120. // protocol version [1 byte]
  121. if data[0] < minProtocolVersion {
  122. return nil, fmt.Errorf(
  123. "Unsupported MySQL Protocol Version %d. Protocol Version %d or higher is required",
  124. data[0],
  125. minProtocolVersion,
  126. )
  127. }
  128. // server version [null terminated string]
  129. // connection id [4 bytes]
  130. pos := 1 + bytes.IndexByte(data[1:], 0x00) + 1 + 4
  131. // first part of the password cipher [8 bytes]
  132. cipher := data[pos : pos+8]
  133. // (filler) always 0x00 [1 byte]
  134. pos += 8 + 1
  135. // capability flags (lower 2 bytes) [2 bytes]
  136. mc.flags = clientFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  137. if mc.flags&clientProtocol41 == 0 {
  138. return nil, errOldProtocol
  139. }
  140. if mc.flags&clientSSL == 0 && mc.cfg.tls != nil {
  141. return nil, errNoTLS
  142. }
  143. pos += 2
  144. if len(data) > pos {
  145. // character set [1 byte]
  146. // status flags [2 bytes]
  147. // capability flags (upper 2 bytes) [2 bytes]
  148. // length of auth-plugin-data [1 byte]
  149. // reserved (all [00]) [10 bytes]
  150. pos += 1 + 2 + 2 + 1 + 10
  151. // second part of the password cipher [12? bytes]
  152. // The documentation is ambiguous about the length.
  153. // The official Python library uses the fixed length 12
  154. // which is not documented but seems to work.
  155. cipher = append(cipher, data[pos:pos+12]...)
  156. // TODO: Verify string termination
  157. // EOF if version (>= 5.5.7 and < 5.5.10) or (>= 5.6.0 and < 5.6.2)
  158. // \NUL otherwise
  159. //
  160. //if data[len(data)-1] == 0 {
  161. // return
  162. //}
  163. //return errMalformPkt
  164. }
  165. return cipher, nil
  166. }
  167. // Client Authentication Packet
  168. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse
  169. func (mc *mysqlConn) writeAuthPacket(cipher []byte) error {
  170. // Adjust client flags based on server support
  171. clientFlags := clientProtocol41 |
  172. clientSecureConn |
  173. clientLongPassword |
  174. clientTransactions |
  175. clientLocalFiles |
  176. mc.flags&clientLongFlag
  177. if mc.cfg.clientFoundRows {
  178. clientFlags |= clientFoundRows
  179. }
  180. // To enable TLS / SSL
  181. if mc.cfg.tls != nil {
  182. clientFlags |= clientSSL
  183. }
  184. // User Password
  185. scrambleBuff := scramblePassword(cipher, []byte(mc.cfg.passwd))
  186. pktLen := 4 + 4 + 1 + 23 + len(mc.cfg.user) + 1 + 1 + len(scrambleBuff)
  187. // To specify a db name
  188. if n := len(mc.cfg.dbname); n > 0 {
  189. clientFlags |= clientConnectWithDB
  190. pktLen += n + 1
  191. }
  192. // Calculate packet length and get buffer with that size
  193. data := mc.buf.takeSmallBuffer(pktLen + 4)
  194. if data == nil {
  195. // can not take the buffer. Something must be wrong with the connection
  196. errLog.Print("Busy buffer")
  197. return driver.ErrBadConn
  198. }
  199. // ClientFlags [32 bit]
  200. data[4] = byte(clientFlags)
  201. data[5] = byte(clientFlags >> 8)
  202. data[6] = byte(clientFlags >> 16)
  203. data[7] = byte(clientFlags >> 24)
  204. // MaxPacketSize [32 bit] (none)
  205. data[8] = 0x00
  206. data[9] = 0x00
  207. data[10] = 0x00
  208. data[11] = 0x00
  209. // Charset [1 byte]
  210. data[12] = collation_utf8_general_ci
  211. // SSL Connection Request Packet
  212. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::SSLRequest
  213. if mc.cfg.tls != nil {
  214. // Send TLS / SSL request packet
  215. if err := mc.writePacket(data[:(4+4+1+23)+4]); err != nil {
  216. return err
  217. }
  218. // Switch to TLS
  219. tlsConn := tls.Client(mc.netConn, mc.cfg.tls)
  220. if err := tlsConn.Handshake(); err != nil {
  221. return err
  222. }
  223. mc.netConn = tlsConn
  224. mc.buf.rd = tlsConn
  225. }
  226. // Filler [23 bytes] (all 0x00)
  227. pos := 13 + 23
  228. // User [null terminated string]
  229. if len(mc.cfg.user) > 0 {
  230. pos += copy(data[pos:], mc.cfg.user)
  231. }
  232. data[pos] = 0x00
  233. pos++
  234. // ScrambleBuffer [length encoded integer]
  235. data[pos] = byte(len(scrambleBuff))
  236. pos += 1 + copy(data[pos+1:], scrambleBuff)
  237. // Databasename [null terminated string]
  238. if len(mc.cfg.dbname) > 0 {
  239. pos += copy(data[pos:], mc.cfg.dbname)
  240. data[pos] = 0x00
  241. }
  242. // Send Auth packet
  243. return mc.writePacket(data)
  244. }
  245. // Client old authentication packet
  246. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthSwitchResponse
  247. func (mc *mysqlConn) writeOldAuthPacket(cipher []byte) error {
  248. // User password
  249. scrambleBuff := scrambleOldPassword(cipher, []byte(mc.cfg.passwd))
  250. // Calculate the packet lenght and add a tailing 0
  251. pktLen := len(scrambleBuff) + 1
  252. data := mc.buf.takeSmallBuffer(pktLen + 4)
  253. if data == nil {
  254. // can not take the buffer. Something must be wrong with the connection
  255. errLog.Print("Busy buffer")
  256. return driver.ErrBadConn
  257. }
  258. // Add the scrambled password [null terminated string]
  259. copy(data[4:], scrambleBuff)
  260. return mc.writePacket(data)
  261. }
  262. /******************************************************************************
  263. * Command Packets *
  264. ******************************************************************************/
  265. func (mc *mysqlConn) writeCommandPacket(command byte) error {
  266. // Reset Packet Sequence
  267. mc.sequence = 0
  268. data := mc.buf.takeSmallBuffer(4 + 1)
  269. if data == nil {
  270. // can not take the buffer. Something must be wrong with the connection
  271. errLog.Print("Busy buffer")
  272. return driver.ErrBadConn
  273. }
  274. // Add command byte
  275. data[4] = command
  276. // Send CMD packet
  277. return mc.writePacket(data)
  278. }
  279. func (mc *mysqlConn) writeCommandPacketStr(command byte, arg string) error {
  280. // Reset Packet Sequence
  281. mc.sequence = 0
  282. pktLen := 1 + len(arg)
  283. data := mc.buf.takeBuffer(pktLen + 4)
  284. if data == nil {
  285. // can not take the buffer. Something must be wrong with the connection
  286. errLog.Print("Busy buffer")
  287. return driver.ErrBadConn
  288. }
  289. // Add command byte
  290. data[4] = command
  291. // Add arg
  292. copy(data[5:], arg)
  293. // Send CMD packet
  294. return mc.writePacket(data)
  295. }
  296. func (mc *mysqlConn) writeCommandPacketUint32(command byte, arg uint32) error {
  297. // Reset Packet Sequence
  298. mc.sequence = 0
  299. data := mc.buf.takeSmallBuffer(4 + 1 + 4)
  300. if data == nil {
  301. // can not take the buffer. Something must be wrong with the connection
  302. errLog.Print("Busy buffer")
  303. return driver.ErrBadConn
  304. }
  305. // Add command byte
  306. data[4] = command
  307. // Add arg [32 bit]
  308. data[5] = byte(arg)
  309. data[6] = byte(arg >> 8)
  310. data[7] = byte(arg >> 16)
  311. data[8] = byte(arg >> 24)
  312. // Send CMD packet
  313. return mc.writePacket(data)
  314. }
  315. /******************************************************************************
  316. * Result Packets *
  317. ******************************************************************************/
  318. // Returns error if Packet is not an 'Result OK'-Packet
  319. func (mc *mysqlConn) readResultOK() error {
  320. data, err := mc.readPacket()
  321. if err == nil {
  322. // packet indicator
  323. switch data[0] {
  324. case iOK:
  325. return mc.handleOkPacket(data)
  326. case iEOF:
  327. // someone is using old_passwords
  328. return errOldPassword
  329. default: // Error otherwise
  330. return mc.handleErrorPacket(data)
  331. }
  332. }
  333. return err
  334. }
  335. // Result Set Header Packet
  336. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::Resultset
  337. func (mc *mysqlConn) readResultSetHeaderPacket() (int, error) {
  338. data, err := mc.readPacket()
  339. if err == nil {
  340. switch data[0] {
  341. case iOK:
  342. return 0, mc.handleOkPacket(data)
  343. case iERR:
  344. return 0, mc.handleErrorPacket(data)
  345. case iLocalInFile:
  346. return 0, mc.handleInFileRequest(string(data[1:]))
  347. }
  348. // column count
  349. num, _, n := readLengthEncodedInteger(data)
  350. if n-len(data) == 0 {
  351. return int(num), nil
  352. }
  353. return 0, errMalformPkt
  354. }
  355. return 0, err
  356. }
  357. // Error Packet
  358. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-ERR_Packet
  359. func (mc *mysqlConn) handleErrorPacket(data []byte) error {
  360. if data[0] != iERR {
  361. return errMalformPkt
  362. }
  363. // 0xff [1 byte]
  364. // Error Number [16 bit uint]
  365. errno := binary.LittleEndian.Uint16(data[1:3])
  366. pos := 3
  367. // SQL State [optional: # + 5bytes string]
  368. if data[3] == 0x23 {
  369. //sqlstate := string(data[4 : 4+5])
  370. pos = 9
  371. }
  372. // Error Message [string]
  373. return &MySQLError{
  374. Number: errno,
  375. Message: string(data[pos:]),
  376. }
  377. }
  378. // Ok Packet
  379. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet
  380. func (mc *mysqlConn) handleOkPacket(data []byte) error {
  381. var n, m int
  382. // 0x00 [1 byte]
  383. // Affected rows [Length Coded Binary]
  384. mc.affectedRows, _, n = readLengthEncodedInteger(data[1:])
  385. // Insert id [Length Coded Binary]
  386. mc.insertId, _, m = readLengthEncodedInteger(data[1+n:])
  387. // server_status [2 bytes]
  388. // warning count [2 bytes]
  389. if !mc.strict {
  390. return nil
  391. } else {
  392. pos := 1 + n + m + 2
  393. if binary.LittleEndian.Uint16(data[pos:pos+2]) > 0 {
  394. return mc.getWarnings()
  395. }
  396. return nil
  397. }
  398. }
  399. // Read Packets as Field Packets until EOF-Packet or an Error appears
  400. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnDefinition41
  401. func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {
  402. columns := make([]mysqlField, count)
  403. for i := 0; ; i++ {
  404. data, err := mc.readPacket()
  405. if err != nil {
  406. return nil, err
  407. }
  408. // EOF Packet
  409. if data[0] == iEOF && (len(data) == 5 || len(data) == 1) {
  410. if i == count {
  411. return columns, nil
  412. }
  413. return nil, fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))
  414. }
  415. // Catalog
  416. pos, err := skipLengthEnodedString(data)
  417. if err != nil {
  418. return nil, err
  419. }
  420. // Database [len coded string]
  421. n, err := skipLengthEnodedString(data[pos:])
  422. if err != nil {
  423. return nil, err
  424. }
  425. pos += n
  426. // Table [len coded string]
  427. n, err = skipLengthEnodedString(data[pos:])
  428. if err != nil {
  429. return nil, err
  430. }
  431. pos += n
  432. // Original table [len coded string]
  433. n, err = skipLengthEnodedString(data[pos:])
  434. if err != nil {
  435. return nil, err
  436. }
  437. pos += n
  438. // Name [len coded string]
  439. name, _, n, err := readLengthEnodedString(data[pos:])
  440. if err != nil {
  441. return nil, err
  442. }
  443. columns[i].name = string(name)
  444. pos += n
  445. // Original name [len coded string]
  446. n, err = skipLengthEnodedString(data[pos:])
  447. if err != nil {
  448. return nil, err
  449. }
  450. // Filler [1 byte]
  451. // Charset [16 bit uint]
  452. // Length [32 bit uint]
  453. pos += n + 1 + 2 + 4
  454. // Field type [byte]
  455. columns[i].fieldType = data[pos]
  456. pos++
  457. // Flags [16 bit uint]
  458. columns[i].flags = fieldFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  459. //pos += 2
  460. // Decimals [8 bit uint]
  461. //pos++
  462. // Default value [len coded binary]
  463. //if pos < len(data) {
  464. // defaultVal, _, err = bytesToLengthCodedBinary(data[pos:])
  465. //}
  466. }
  467. }
  468. // Read Packets as Field Packets until EOF-Packet or an Error appears
  469. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::ResultsetRow
  470. func (rows *textRows) readRow(dest []driver.Value) error {
  471. mc := rows.mc
  472. data, err := mc.readPacket()
  473. if err != nil {
  474. return err
  475. }
  476. // EOF Packet
  477. if data[0] == iEOF && len(data) == 5 {
  478. return io.EOF
  479. }
  480. // RowSet Packet
  481. var n int
  482. var isNull bool
  483. pos := 0
  484. for i := range dest {
  485. // Read bytes and convert to string
  486. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  487. pos += n
  488. if err == nil {
  489. if !isNull {
  490. if !mc.parseTime {
  491. continue
  492. } else {
  493. switch rows.columns[i].fieldType {
  494. case fieldTypeTimestamp, fieldTypeDateTime,
  495. fieldTypeDate, fieldTypeNewDate:
  496. dest[i], err = parseDateTime(
  497. string(dest[i].([]byte)),
  498. mc.cfg.loc,
  499. )
  500. if err == nil {
  501. continue
  502. }
  503. default:
  504. continue
  505. }
  506. }
  507. } else {
  508. dest[i] = nil
  509. continue
  510. }
  511. }
  512. return err // err != nil
  513. }
  514. return nil
  515. }
  516. // Reads Packets until EOF-Packet or an Error appears. Returns count of Packets read
  517. func (mc *mysqlConn) readUntilEOF() error {
  518. for {
  519. data, err := mc.readPacket()
  520. // No Err and no EOF Packet
  521. if err == nil && data[0] != iEOF {
  522. continue
  523. }
  524. return err // Err or EOF
  525. }
  526. }
  527. /******************************************************************************
  528. * Prepared Statements *
  529. ******************************************************************************/
  530. // Prepare Result Packets
  531. // http://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html
  532. func (stmt *mysqlStmt) readPrepareResultPacket() (uint16, error) {
  533. data, err := stmt.mc.readPacket()
  534. if err == nil {
  535. // packet indicator [1 byte]
  536. if data[0] != iOK {
  537. return 0, stmt.mc.handleErrorPacket(data)
  538. }
  539. // statement id [4 bytes]
  540. stmt.id = binary.LittleEndian.Uint32(data[1:5])
  541. // Column count [16 bit uint]
  542. columnCount := binary.LittleEndian.Uint16(data[5:7])
  543. // Param count [16 bit uint]
  544. stmt.paramCount = int(binary.LittleEndian.Uint16(data[7:9]))
  545. // Reserved [8 bit]
  546. // Warning count [16 bit uint]
  547. if !stmt.mc.strict {
  548. return columnCount, nil
  549. } else {
  550. // Check for warnings count > 0, only available in MySQL > 4.1
  551. if len(data) >= 12 && binary.LittleEndian.Uint16(data[10:12]) > 0 {
  552. return columnCount, stmt.mc.getWarnings()
  553. }
  554. return columnCount, nil
  555. }
  556. }
  557. return 0, err
  558. }
  559. // http://dev.mysql.com/doc/internals/en/com-stmt-send-long-data.html
  560. func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {
  561. maxLen := stmt.mc.maxPacketAllowed - 1
  562. pktLen := maxLen
  563. // After the header (bytes 0-3) follows before the data:
  564. // 1 byte command
  565. // 4 bytes stmtID
  566. // 2 bytes paramID
  567. const dataOffset = 1 + 4 + 2
  568. // Can not use the write buffer since
  569. // a) the buffer is too small
  570. // b) it is in use
  571. data := make([]byte, 4+1+4+2+len(arg))
  572. copy(data[4+dataOffset:], arg)
  573. for argLen := len(arg); argLen > 0; argLen -= pktLen - dataOffset {
  574. if dataOffset+argLen < maxLen {
  575. pktLen = dataOffset + argLen
  576. }
  577. stmt.mc.sequence = 0
  578. // Add command byte [1 byte]
  579. data[4] = comStmtSendLongData
  580. // Add stmtID [32 bit]
  581. data[5] = byte(stmt.id)
  582. data[6] = byte(stmt.id >> 8)
  583. data[7] = byte(stmt.id >> 16)
  584. data[8] = byte(stmt.id >> 24)
  585. // Add paramID [16 bit]
  586. data[9] = byte(paramID)
  587. data[10] = byte(paramID >> 8)
  588. // Send CMD packet
  589. err := stmt.mc.writePacket(data[:4+pktLen])
  590. if err == nil {
  591. data = data[pktLen-dataOffset:]
  592. continue
  593. }
  594. return err
  595. }
  596. // Reset Packet Sequence
  597. stmt.mc.sequence = 0
  598. return nil
  599. }
  600. // Execute Prepared Statement
  601. // http://dev.mysql.com/doc/internals/en/com-stmt-execute.html
  602. func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
  603. if len(args) != stmt.paramCount {
  604. return fmt.Errorf(
  605. "Arguments count mismatch (Got: %d Has: %d)",
  606. len(args),
  607. stmt.paramCount,
  608. )
  609. }
  610. mc := stmt.mc
  611. // Reset packet-sequence
  612. mc.sequence = 0
  613. var data []byte
  614. if len(args) == 0 {
  615. const pktLen = 1 + 4 + 1 + 4
  616. data = mc.buf.takeBuffer(4 + pktLen)
  617. if data == nil {
  618. // can not take the buffer. Something must be wrong with the connection
  619. errLog.Print("Busy buffer")
  620. return driver.ErrBadConn
  621. }
  622. // packet header [4 bytes]
  623. data[0] = byte(pktLen)
  624. data[1] = byte(pktLen >> 8)
  625. data[2] = byte(pktLen >> 16)
  626. data[3] = 0x00 // new command, sequence id is always 0
  627. } else {
  628. data = mc.buf.takeCompleteBuffer()
  629. if data == nil {
  630. // can not take the buffer. Something must be wrong with the connection
  631. errLog.Print("Busy buffer")
  632. return driver.ErrBadConn
  633. }
  634. // header (bytes 0-3) is added after we know the packet size
  635. }
  636. // command [1 byte]
  637. data[4] = comStmtExecute
  638. // statement_id [4 bytes]
  639. data[5] = byte(stmt.id)
  640. data[6] = byte(stmt.id >> 8)
  641. data[7] = byte(stmt.id >> 16)
  642. data[8] = byte(stmt.id >> 24)
  643. // flags (0: CURSOR_TYPE_NO_CURSOR) [1 byte]
  644. data[9] = 0x00
  645. // iteration_count (uint32(1)) [4 bytes]
  646. data[10] = 0x01
  647. data[11] = 0x00
  648. data[12] = 0x00
  649. data[13] = 0x00
  650. if len(args) > 0 {
  651. // NULL-bitmap [(len(args)+7)/8 bytes]
  652. nullMask := uint64(0)
  653. pos := 4 + 1 + 4 + 1 + 4 + ((len(args) + 7) >> 3)
  654. // newParameterBoundFlag 1 [1 byte]
  655. data[pos] = 0x01
  656. pos++
  657. // type of each parameter [len(args)*2 bytes]
  658. paramTypes := data[pos:]
  659. pos += (len(args) << 1)
  660. // value of each parameter [n bytes]
  661. paramValues := data[pos:pos]
  662. valuesCap := cap(paramValues)
  663. for i := range args {
  664. // build NULL-bitmap
  665. if args[i] == nil {
  666. nullMask |= 1 << uint(i)
  667. paramTypes[i+i] = fieldTypeNULL
  668. paramTypes[i+i+1] = 0x00
  669. continue
  670. }
  671. // cache types and values
  672. switch v := args[i].(type) {
  673. case int64:
  674. paramTypes[i+i] = fieldTypeLongLong
  675. paramTypes[i+i+1] = 0x00
  676. if cap(paramValues)-len(paramValues)-8 >= 0 {
  677. paramValues = paramValues[:len(paramValues)+8]
  678. binary.LittleEndian.PutUint64(
  679. paramValues[len(paramValues)-8:],
  680. uint64(v),
  681. )
  682. } else {
  683. paramValues = append(paramValues,
  684. uint64ToBytes(uint64(v))...,
  685. )
  686. }
  687. case float64:
  688. paramTypes[i+i] = fieldTypeDouble
  689. paramTypes[i+i+1] = 0x00
  690. if cap(paramValues)-len(paramValues)-8 >= 0 {
  691. paramValues = paramValues[:len(paramValues)+8]
  692. binary.LittleEndian.PutUint64(
  693. paramValues[len(paramValues)-8:],
  694. math.Float64bits(v),
  695. )
  696. } else {
  697. paramValues = append(paramValues,
  698. uint64ToBytes(math.Float64bits(v))...,
  699. )
  700. }
  701. case bool:
  702. paramTypes[i+i] = fieldTypeTiny
  703. paramTypes[i+i+1] = 0x00
  704. if v {
  705. paramValues = append(paramValues, 0x01)
  706. } else {
  707. paramValues = append(paramValues, 0x00)
  708. }
  709. case []byte:
  710. // Common case (non-nil value) first
  711. if v != nil {
  712. paramTypes[i+i] = fieldTypeString
  713. paramTypes[i+i+1] = 0x00
  714. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  715. paramValues = appendLengthEncodedInteger(paramValues,
  716. uint64(len(v)),
  717. )
  718. paramValues = append(paramValues, v...)
  719. } else {
  720. if err := stmt.writeCommandLongData(i, v); err != nil {
  721. return err
  722. }
  723. }
  724. continue
  725. }
  726. // Handle []byte(nil) as a NULL value
  727. nullMask |= 1 << uint(i)
  728. paramTypes[i+i] = fieldTypeNULL
  729. paramTypes[i+i+1] = 0x00
  730. case string:
  731. paramTypes[i+i] = fieldTypeString
  732. paramTypes[i+i+1] = 0x00
  733. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  734. paramValues = appendLengthEncodedInteger(paramValues,
  735. uint64(len(v)),
  736. )
  737. paramValues = append(paramValues, v...)
  738. } else {
  739. if err := stmt.writeCommandLongData(i, []byte(v)); err != nil {
  740. return err
  741. }
  742. }
  743. case time.Time:
  744. paramTypes[i+i] = fieldTypeString
  745. paramTypes[i+i+1] = 0x00
  746. var val []byte
  747. if v.IsZero() {
  748. val = []byte("0000-00-00")
  749. } else {
  750. val = []byte(v.In(mc.cfg.loc).Format(timeFormat))
  751. }
  752. paramValues = appendLengthEncodedInteger(paramValues,
  753. uint64(len(val)),
  754. )
  755. paramValues = append(paramValues, val...)
  756. default:
  757. return fmt.Errorf("Can't convert type: %T", args[i])
  758. }
  759. }
  760. // Check if param values exceeded the available buffer
  761. // In that case we must build the data packet with the new values buffer
  762. if valuesCap != cap(paramValues) {
  763. data = append(data[:pos], paramValues...)
  764. mc.buf.buf = data
  765. }
  766. pos += len(paramValues)
  767. data = data[:pos]
  768. // Convert nullMask to bytes
  769. for i, max := 0, (stmt.paramCount+7)>>3; i < max; i++ {
  770. data[i+14] = byte(nullMask >> uint(i<<3))
  771. }
  772. }
  773. return mc.writePacket(data)
  774. }
  775. // http://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html
  776. func (rows *binaryRows) readRow(dest []driver.Value) error {
  777. data, err := rows.mc.readPacket()
  778. if err != nil {
  779. return err
  780. }
  781. // packet indicator [1 byte]
  782. if data[0] != iOK {
  783. // EOF Packet
  784. if data[0] == iEOF && len(data) == 5 {
  785. return io.EOF
  786. }
  787. // Error otherwise
  788. return rows.mc.handleErrorPacket(data)
  789. }
  790. // NULL-bitmap, [(column-count + 7 + 2) / 8 bytes]
  791. pos := 1 + (len(dest)+7+2)>>3
  792. nullMask := data[1:pos]
  793. for i := range dest {
  794. // Field is NULL
  795. // (byte >> bit-pos) % 2 == 1
  796. if ((nullMask[(i+2)>>3] >> uint((i+2)&7)) & 1) == 1 {
  797. dest[i] = nil
  798. continue
  799. }
  800. // Convert to byte-coded string
  801. switch rows.columns[i].fieldType {
  802. case fieldTypeNULL:
  803. dest[i] = nil
  804. continue
  805. // Numeric Types
  806. case fieldTypeTiny:
  807. if rows.columns[i].flags&flagUnsigned != 0 {
  808. dest[i] = int64(data[pos])
  809. } else {
  810. dest[i] = int64(int8(data[pos]))
  811. }
  812. pos++
  813. continue
  814. case fieldTypeShort, fieldTypeYear:
  815. if rows.columns[i].flags&flagUnsigned != 0 {
  816. dest[i] = int64(binary.LittleEndian.Uint16(data[pos : pos+2]))
  817. } else {
  818. dest[i] = int64(int16(binary.LittleEndian.Uint16(data[pos : pos+2])))
  819. }
  820. pos += 2
  821. continue
  822. case fieldTypeInt24, fieldTypeLong:
  823. if rows.columns[i].flags&flagUnsigned != 0 {
  824. dest[i] = int64(binary.LittleEndian.Uint32(data[pos : pos+4]))
  825. } else {
  826. dest[i] = int64(int32(binary.LittleEndian.Uint32(data[pos : pos+4])))
  827. }
  828. pos += 4
  829. continue
  830. case fieldTypeLongLong:
  831. if rows.columns[i].flags&flagUnsigned != 0 {
  832. val := binary.LittleEndian.Uint64(data[pos : pos+8])
  833. if val > math.MaxInt64 {
  834. dest[i] = uint64ToString(val)
  835. } else {
  836. dest[i] = int64(val)
  837. }
  838. } else {
  839. dest[i] = int64(binary.LittleEndian.Uint64(data[pos : pos+8]))
  840. }
  841. pos += 8
  842. continue
  843. case fieldTypeFloat:
  844. dest[i] = float64(math.Float32frombits(binary.LittleEndian.Uint32(data[pos : pos+4])))
  845. pos += 4
  846. continue
  847. case fieldTypeDouble:
  848. dest[i] = math.Float64frombits(binary.LittleEndian.Uint64(data[pos : pos+8]))
  849. pos += 8
  850. continue
  851. // Length coded Binary Strings
  852. case fieldTypeDecimal, fieldTypeNewDecimal, fieldTypeVarChar,
  853. fieldTypeBit, fieldTypeEnum, fieldTypeSet, fieldTypeTinyBLOB,
  854. fieldTypeMediumBLOB, fieldTypeLongBLOB, fieldTypeBLOB,
  855. fieldTypeVarString, fieldTypeString, fieldTypeGeometry:
  856. var isNull bool
  857. var n int
  858. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  859. pos += n
  860. if err == nil {
  861. if !isNull {
  862. continue
  863. } else {
  864. dest[i] = nil
  865. continue
  866. }
  867. }
  868. return err
  869. // Date YYYY-MM-DD
  870. case fieldTypeDate, fieldTypeNewDate:
  871. num, isNull, n := readLengthEncodedInteger(data[pos:])
  872. pos += n
  873. if isNull {
  874. dest[i] = nil
  875. continue
  876. }
  877. if rows.mc.parseTime {
  878. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  879. } else {
  880. dest[i], err = formatBinaryDate(num, data[pos:])
  881. }
  882. if err == nil {
  883. pos += int(num)
  884. continue
  885. } else {
  886. return err
  887. }
  888. // Time [-][H]HH:MM:SS[.fractal]
  889. case fieldTypeTime:
  890. num, isNull, n := readLengthEncodedInteger(data[pos:])
  891. pos += n
  892. if num == 0 {
  893. if isNull {
  894. dest[i] = nil
  895. continue
  896. } else {
  897. dest[i] = []byte("00:00:00")
  898. continue
  899. }
  900. }
  901. var sign string
  902. if data[pos] == 1 {
  903. sign = "-"
  904. }
  905. switch num {
  906. case 8:
  907. dest[i] = []byte(fmt.Sprintf(
  908. sign+"%02d:%02d:%02d",
  909. uint16(data[pos+1])*24+uint16(data[pos+5]),
  910. data[pos+6],
  911. data[pos+7],
  912. ))
  913. pos += 8
  914. continue
  915. case 12:
  916. dest[i] = []byte(fmt.Sprintf(
  917. sign+"%02d:%02d:%02d.%06d",
  918. uint16(data[pos+1])*24+uint16(data[pos+5]),
  919. data[pos+6],
  920. data[pos+7],
  921. binary.LittleEndian.Uint32(data[pos+8:pos+12]),
  922. ))
  923. pos += 12
  924. continue
  925. default:
  926. return fmt.Errorf("Invalid TIME-packet length %d", num)
  927. }
  928. // Timestamp YYYY-MM-DD HH:MM:SS[.fractal]
  929. case fieldTypeTimestamp, fieldTypeDateTime:
  930. num, isNull, n := readLengthEncodedInteger(data[pos:])
  931. pos += n
  932. if isNull {
  933. dest[i] = nil
  934. continue
  935. }
  936. if rows.mc.parseTime {
  937. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  938. } else {
  939. dest[i], err = formatBinaryDateTime(num, data[pos:])
  940. }
  941. if err == nil {
  942. pos += int(num)
  943. continue
  944. } else {
  945. return err
  946. }
  947. // Please report if this happens!
  948. default:
  949. return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)
  950. }
  951. }
  952. return nil
  953. }