packets.go 28 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196
  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. // Packet header [24bit length + 1 byte sequence]
  215. data[0] = byte((4 + 4 + 1 + 23))
  216. data[1] = byte((4 + 4 + 1 + 23) >> 8)
  217. data[2] = byte((4 + 4 + 1 + 23) >> 16)
  218. data[3] = mc.sequence
  219. // Send TLS / SSL request packet
  220. if err := mc.writePacket(data[:(4+4+1+23)+4]); err != nil {
  221. return err
  222. }
  223. // Switch to TLS
  224. tlsConn := tls.Client(mc.netConn, mc.cfg.tls)
  225. if err := tlsConn.Handshake(); err != nil {
  226. return err
  227. }
  228. mc.netConn = tlsConn
  229. mc.buf.rd = tlsConn
  230. }
  231. // Add the packet header [24bit length + 1 byte sequence]
  232. data[0] = byte(pktLen)
  233. data[1] = byte(pktLen >> 8)
  234. data[2] = byte(pktLen >> 16)
  235. data[3] = mc.sequence
  236. // Filler [23 bytes] (all 0x00)
  237. pos := 13 + 23
  238. // User [null terminated string]
  239. if len(mc.cfg.user) > 0 {
  240. pos += copy(data[pos:], mc.cfg.user)
  241. }
  242. data[pos] = 0x00
  243. pos++
  244. // ScrambleBuffer [length encoded integer]
  245. data[pos] = byte(len(scrambleBuff))
  246. pos += 1 + copy(data[pos+1:], scrambleBuff)
  247. // Databasename [null terminated string]
  248. if len(mc.cfg.dbname) > 0 {
  249. pos += copy(data[pos:], mc.cfg.dbname)
  250. data[pos] = 0x00
  251. }
  252. // Send Auth packet
  253. return mc.writePacket(data)
  254. }
  255. // Client old authentication packet
  256. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthSwitchResponse
  257. func (mc *mysqlConn) writeOldAuthPacket(cipher []byte) error {
  258. // User password
  259. scrambleBuff := scrambleOldPassword(cipher, []byte(mc.cfg.passwd))
  260. // Calculate the packet lenght and add a tailing 0
  261. pktLen := len(scrambleBuff) + 1
  262. data := mc.buf.takeSmallBuffer(pktLen + 4)
  263. if data == nil {
  264. // can not take the buffer. Something must be wrong with the connection
  265. errLog.Print("Busy buffer")
  266. return driver.ErrBadConn
  267. }
  268. // Add the packet header [24bit length + 1 byte sequence]
  269. data[0] = byte(pktLen)
  270. data[1] = byte(pktLen >> 8)
  271. data[2] = byte(pktLen >> 16)
  272. data[3] = mc.sequence
  273. // Add the scrambled password [null terminated string]
  274. copy(data[4:], scrambleBuff)
  275. return mc.writePacket(data)
  276. }
  277. /******************************************************************************
  278. * Command Packets *
  279. ******************************************************************************/
  280. func (mc *mysqlConn) writeCommandPacket(command byte) error {
  281. // Reset Packet Sequence
  282. mc.sequence = 0
  283. data := mc.buf.takeSmallBuffer(4 + 1)
  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 the packet header [24bit length + 1 byte sequence]
  290. data[0] = 0x01 // 1 byte long
  291. data[1] = 0x00
  292. data[2] = 0x00
  293. data[3] = 0x00 // new command, sequence id is always 0
  294. // Add command byte
  295. data[4] = command
  296. // Send CMD packet
  297. return mc.writePacket(data)
  298. }
  299. func (mc *mysqlConn) writeCommandPacketStr(command byte, arg string) error {
  300. // Reset Packet Sequence
  301. mc.sequence = 0
  302. pktLen := 1 + len(arg)
  303. data := mc.buf.takeBuffer(pktLen + 4)
  304. if data == nil {
  305. // can not take the buffer. Something must be wrong with the connection
  306. errLog.Print("Busy buffer")
  307. return driver.ErrBadConn
  308. }
  309. // Add the packet header [24bit length + 1 byte sequence]
  310. data[0] = byte(pktLen)
  311. data[1] = byte(pktLen >> 8)
  312. data[2] = byte(pktLen >> 16)
  313. data[3] = 0x00 // new command, sequence id is always 0
  314. // Add command byte
  315. data[4] = command
  316. // Add arg
  317. copy(data[5:], arg)
  318. // Send CMD packet
  319. return mc.writePacket(data)
  320. }
  321. func (mc *mysqlConn) writeCommandPacketUint32(command byte, arg uint32) error {
  322. // Reset Packet Sequence
  323. mc.sequence = 0
  324. data := mc.buf.takeSmallBuffer(4 + 1 + 4)
  325. if data == nil {
  326. // can not take the buffer. Something must be wrong with the connection
  327. errLog.Print("Busy buffer")
  328. return driver.ErrBadConn
  329. }
  330. // Add the packet header [24bit length + 1 byte sequence]
  331. data[0] = 0x05 // 5 bytes long
  332. data[1] = 0x00
  333. data[2] = 0x00
  334. data[3] = 0x00 // new command, sequence id is always 0
  335. // Add command byte
  336. data[4] = command
  337. // Add arg [32 bit]
  338. data[5] = byte(arg)
  339. data[6] = byte(arg >> 8)
  340. data[7] = byte(arg >> 16)
  341. data[8] = byte(arg >> 24)
  342. // Send CMD packet
  343. return mc.writePacket(data)
  344. }
  345. /******************************************************************************
  346. * Result Packets *
  347. ******************************************************************************/
  348. // Returns error if Packet is not an 'Result OK'-Packet
  349. func (mc *mysqlConn) readResultOK() error {
  350. data, err := mc.readPacket()
  351. if err == nil {
  352. // packet indicator
  353. switch data[0] {
  354. case iOK:
  355. return mc.handleOkPacket(data)
  356. case iEOF:
  357. // someone is using old_passwords
  358. return errOldPassword
  359. default: // Error otherwise
  360. return mc.handleErrorPacket(data)
  361. }
  362. }
  363. return err
  364. }
  365. // Result Set Header Packet
  366. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::Resultset
  367. func (mc *mysqlConn) readResultSetHeaderPacket() (int, error) {
  368. data, err := mc.readPacket()
  369. if err == nil {
  370. switch data[0] {
  371. case iOK:
  372. return 0, mc.handleOkPacket(data)
  373. case iERR:
  374. return 0, mc.handleErrorPacket(data)
  375. case iLocalInFile:
  376. return 0, mc.handleInFileRequest(string(data[1:]))
  377. }
  378. // column count
  379. num, _, n := readLengthEncodedInteger(data)
  380. if n-len(data) == 0 {
  381. return int(num), nil
  382. }
  383. return 0, errMalformPkt
  384. }
  385. return 0, err
  386. }
  387. // Error Packet
  388. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-ERR_Packet
  389. func (mc *mysqlConn) handleErrorPacket(data []byte) error {
  390. if data[0] != iERR {
  391. return errMalformPkt
  392. }
  393. // 0xff [1 byte]
  394. // Error Number [16 bit uint]
  395. errno := binary.LittleEndian.Uint16(data[1:3])
  396. pos := 3
  397. // SQL State [optional: # + 5bytes string]
  398. if data[3] == 0x23 {
  399. //sqlstate := string(data[4 : 4+5])
  400. pos = 9
  401. }
  402. // Error Message [string]
  403. return &MySQLError{
  404. Number: errno,
  405. Message: string(data[pos:]),
  406. }
  407. }
  408. // Ok Packet
  409. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet
  410. func (mc *mysqlConn) handleOkPacket(data []byte) error {
  411. var n, m int
  412. // 0x00 [1 byte]
  413. // Affected rows [Length Coded Binary]
  414. mc.affectedRows, _, n = readLengthEncodedInteger(data[1:])
  415. // Insert id [Length Coded Binary]
  416. mc.insertId, _, m = readLengthEncodedInteger(data[1+n:])
  417. // server_status [2 bytes]
  418. // warning count [2 bytes]
  419. if !mc.strict {
  420. return nil
  421. } else {
  422. pos := 1 + n + m + 2
  423. if binary.LittleEndian.Uint16(data[pos:pos+2]) > 0 {
  424. return mc.getWarnings()
  425. }
  426. return nil
  427. }
  428. }
  429. // Read Packets as Field Packets until EOF-Packet or an Error appears
  430. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnDefinition41
  431. func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {
  432. columns := make([]mysqlField, count)
  433. for i := 0; ; i++ {
  434. data, err := mc.readPacket()
  435. if err != nil {
  436. return nil, err
  437. }
  438. // EOF Packet
  439. if data[0] == iEOF && (len(data) == 5 || len(data) == 1) {
  440. if i == count {
  441. return columns, nil
  442. }
  443. return nil, fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))
  444. }
  445. // Catalog
  446. pos, err := skipLengthEnodedString(data)
  447. if err != nil {
  448. return nil, err
  449. }
  450. // Database [len coded string]
  451. n, err := skipLengthEnodedString(data[pos:])
  452. if err != nil {
  453. return nil, err
  454. }
  455. pos += n
  456. // Table [len coded string]
  457. n, err = skipLengthEnodedString(data[pos:])
  458. if err != nil {
  459. return nil, err
  460. }
  461. pos += n
  462. // Original table [len coded string]
  463. n, err = skipLengthEnodedString(data[pos:])
  464. if err != nil {
  465. return nil, err
  466. }
  467. pos += n
  468. // Name [len coded string]
  469. name, _, n, err := readLengthEnodedString(data[pos:])
  470. if err != nil {
  471. return nil, err
  472. }
  473. columns[i].name = string(name)
  474. pos += n
  475. // Original name [len coded string]
  476. n, err = skipLengthEnodedString(data[pos:])
  477. if err != nil {
  478. return nil, err
  479. }
  480. // Filler [1 byte]
  481. // Charset [16 bit uint]
  482. // Length [32 bit uint]
  483. pos += n + 1 + 2 + 4
  484. // Field type [byte]
  485. columns[i].fieldType = data[pos]
  486. pos++
  487. // Flags [16 bit uint]
  488. columns[i].flags = fieldFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  489. //pos += 2
  490. // Decimals [8 bit uint]
  491. //pos++
  492. // Default value [len coded binary]
  493. //if pos < len(data) {
  494. // defaultVal, _, err = bytesToLengthCodedBinary(data[pos:])
  495. //}
  496. }
  497. }
  498. // Read Packets as Field Packets until EOF-Packet or an Error appears
  499. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::ResultsetRow
  500. func (rows *textRows) readRow(dest []driver.Value) error {
  501. mc := rows.mc
  502. data, err := mc.readPacket()
  503. if err != nil {
  504. return err
  505. }
  506. // EOF Packet
  507. if data[0] == iEOF && len(data) == 5 {
  508. return io.EOF
  509. }
  510. // RowSet Packet
  511. var n int
  512. var isNull bool
  513. pos := 0
  514. for i := range dest {
  515. // Read bytes and convert to string
  516. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  517. pos += n
  518. if err == nil {
  519. if !isNull {
  520. if !mc.parseTime {
  521. continue
  522. } else {
  523. switch rows.columns[i].fieldType {
  524. case fieldTypeTimestamp, fieldTypeDateTime,
  525. fieldTypeDate, fieldTypeNewDate:
  526. dest[i], err = parseDateTime(
  527. string(dest[i].([]byte)),
  528. mc.cfg.loc,
  529. )
  530. if err == nil {
  531. continue
  532. }
  533. default:
  534. continue
  535. }
  536. }
  537. } else {
  538. dest[i] = nil
  539. continue
  540. }
  541. }
  542. return err // err != nil
  543. }
  544. return nil
  545. }
  546. // Reads Packets until EOF-Packet or an Error appears. Returns count of Packets read
  547. func (mc *mysqlConn) readUntilEOF() error {
  548. for {
  549. data, err := mc.readPacket()
  550. // No Err and no EOF Packet
  551. if err == nil && data[0] != iEOF {
  552. continue
  553. }
  554. return err // Err or EOF
  555. }
  556. }
  557. /******************************************************************************
  558. * Prepared Statements *
  559. ******************************************************************************/
  560. // Prepare Result Packets
  561. // http://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html
  562. func (stmt *mysqlStmt) readPrepareResultPacket() (uint16, error) {
  563. data, err := stmt.mc.readPacket()
  564. if err == nil {
  565. // packet indicator [1 byte]
  566. if data[0] != iOK {
  567. return 0, stmt.mc.handleErrorPacket(data)
  568. }
  569. // statement id [4 bytes]
  570. stmt.id = binary.LittleEndian.Uint32(data[1:5])
  571. // Column count [16 bit uint]
  572. columnCount := binary.LittleEndian.Uint16(data[5:7])
  573. // Param count [16 bit uint]
  574. stmt.paramCount = int(binary.LittleEndian.Uint16(data[7:9]))
  575. // Reserved [8 bit]
  576. // Warning count [16 bit uint]
  577. if !stmt.mc.strict {
  578. return columnCount, nil
  579. } else {
  580. // Check for warnings count > 0, only available in MySQL > 4.1
  581. if len(data) >= 12 && binary.LittleEndian.Uint16(data[10:12]) > 0 {
  582. return columnCount, stmt.mc.getWarnings()
  583. }
  584. return columnCount, nil
  585. }
  586. }
  587. return 0, err
  588. }
  589. // http://dev.mysql.com/doc/internals/en/com-stmt-send-long-data.html
  590. func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {
  591. maxLen := stmt.mc.maxPacketAllowed - 1
  592. pktLen := maxLen
  593. // After the header (bytes 0-3) follows before the data:
  594. // 1 byte command
  595. // 4 bytes stmtID
  596. // 2 bytes paramID
  597. const dataOffset = 1 + 4 + 2
  598. // Can not use the write buffer since
  599. // a) the buffer is too small
  600. // b) it is in use
  601. data := make([]byte, 4+1+4+2+len(arg))
  602. copy(data[4+dataOffset:], arg)
  603. for argLen := len(arg); argLen > 0; argLen -= pktLen - dataOffset {
  604. if dataOffset+argLen < maxLen {
  605. pktLen = dataOffset + argLen
  606. }
  607. stmt.mc.sequence = 0
  608. // Add the packet header [24bit length + 1 byte sequence]
  609. data[0] = byte(pktLen)
  610. data[1] = byte(pktLen >> 8)
  611. data[2] = byte(pktLen >> 16)
  612. data[3] = 0x00 // mc.sequence
  613. // Add command byte [1 byte]
  614. data[4] = comStmtSendLongData
  615. // Add stmtID [32 bit]
  616. data[5] = byte(stmt.id)
  617. data[6] = byte(stmt.id >> 8)
  618. data[7] = byte(stmt.id >> 16)
  619. data[8] = byte(stmt.id >> 24)
  620. // Add paramID [16 bit]
  621. data[9] = byte(paramID)
  622. data[10] = byte(paramID >> 8)
  623. // Send CMD packet
  624. err := stmt.mc.writePacket(data[:4+pktLen])
  625. if err == nil {
  626. data = data[pktLen-dataOffset:]
  627. continue
  628. }
  629. return err
  630. }
  631. // Reset Packet Sequence
  632. stmt.mc.sequence = 0
  633. return nil
  634. }
  635. // Execute Prepared Statement
  636. // http://dev.mysql.com/doc/internals/en/com-stmt-execute.html
  637. func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
  638. if len(args) != stmt.paramCount {
  639. return fmt.Errorf(
  640. "Arguments count mismatch (Got: %d Has: %d)",
  641. len(args),
  642. stmt.paramCount,
  643. )
  644. }
  645. mc := stmt.mc
  646. // Reset packet-sequence
  647. mc.sequence = 0
  648. var data []byte
  649. if len(args) == 0 {
  650. const pktLen = 1 + 4 + 1 + 4
  651. data = mc.buf.takeBuffer(4 + pktLen)
  652. if data == nil {
  653. // can not take the buffer. Something must be wrong with the connection
  654. errLog.Print("Busy buffer")
  655. return driver.ErrBadConn
  656. }
  657. // packet header [4 bytes]
  658. data[0] = byte(pktLen)
  659. data[1] = byte(pktLen >> 8)
  660. data[2] = byte(pktLen >> 16)
  661. data[3] = 0x00 // new command, sequence id is always 0
  662. } else {
  663. data = mc.buf.takeCompleteBuffer()
  664. if data == nil {
  665. // can not take the buffer. Something must be wrong with the connection
  666. errLog.Print("Busy buffer")
  667. return driver.ErrBadConn
  668. }
  669. // header (bytes 0-3) is added after we know the packet size
  670. }
  671. // command [1 byte]
  672. data[4] = comStmtExecute
  673. // statement_id [4 bytes]
  674. data[5] = byte(stmt.id)
  675. data[6] = byte(stmt.id >> 8)
  676. data[7] = byte(stmt.id >> 16)
  677. data[8] = byte(stmt.id >> 24)
  678. // flags (0: CURSOR_TYPE_NO_CURSOR) [1 byte]
  679. data[9] = 0x00
  680. // iteration_count (uint32(1)) [4 bytes]
  681. data[10] = 0x01
  682. data[11] = 0x00
  683. data[12] = 0x00
  684. data[13] = 0x00
  685. if len(args) > 0 {
  686. // NULL-bitmap [(len(args)+7)/8 bytes]
  687. nullMask := uint64(0)
  688. pos := 4 + 1 + 4 + 1 + 4 + ((len(args) + 7) >> 3)
  689. // newParameterBoundFlag 1 [1 byte]
  690. data[pos] = 0x01
  691. pos++
  692. // type of each parameter [len(args)*2 bytes]
  693. paramTypes := data[pos:]
  694. pos += (len(args) << 1)
  695. // value of each parameter [n bytes]
  696. paramValues := data[pos:pos]
  697. valuesCap := cap(paramValues)
  698. for i := range args {
  699. // build NULL-bitmap
  700. if args[i] == nil {
  701. nullMask |= 1 << uint(i)
  702. paramTypes[i+i] = fieldTypeNULL
  703. paramTypes[i+i+1] = 0x00
  704. continue
  705. }
  706. // cache types and values
  707. switch v := args[i].(type) {
  708. case int64:
  709. paramTypes[i+i] = fieldTypeLongLong
  710. paramTypes[i+i+1] = 0x00
  711. if cap(paramValues)-len(paramValues)-8 >= 0 {
  712. paramValues = paramValues[:len(paramValues)+8]
  713. binary.LittleEndian.PutUint64(
  714. paramValues[len(paramValues)-8:],
  715. uint64(v),
  716. )
  717. } else {
  718. paramValues = append(paramValues,
  719. uint64ToBytes(uint64(v))...,
  720. )
  721. }
  722. case float64:
  723. paramTypes[i+i] = fieldTypeDouble
  724. paramTypes[i+i+1] = 0x00
  725. if cap(paramValues)-len(paramValues)-8 >= 0 {
  726. paramValues = paramValues[:len(paramValues)+8]
  727. binary.LittleEndian.PutUint64(
  728. paramValues[len(paramValues)-8:],
  729. math.Float64bits(v),
  730. )
  731. } else {
  732. paramValues = append(paramValues,
  733. uint64ToBytes(math.Float64bits(v))...,
  734. )
  735. }
  736. case bool:
  737. paramTypes[i+i] = fieldTypeTiny
  738. paramTypes[i+i+1] = 0x00
  739. if v {
  740. paramValues = append(paramValues, 0x01)
  741. } else {
  742. paramValues = append(paramValues, 0x00)
  743. }
  744. case []byte:
  745. // Common case (non-nil value) first
  746. if v != nil {
  747. paramTypes[i+i] = fieldTypeString
  748. paramTypes[i+i+1] = 0x00
  749. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  750. paramValues = appendLengthEncodedInteger(paramValues,
  751. uint64(len(v)),
  752. )
  753. paramValues = append(paramValues, v...)
  754. } else {
  755. if err := stmt.writeCommandLongData(i, v); err != nil {
  756. return err
  757. }
  758. }
  759. continue
  760. }
  761. // Handle []byte(nil) as a NULL value
  762. nullMask |= 1 << uint(i)
  763. paramTypes[i+i] = fieldTypeNULL
  764. paramTypes[i+i+1] = 0x00
  765. case string:
  766. paramTypes[i+i] = fieldTypeString
  767. paramTypes[i+i+1] = 0x00
  768. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  769. paramValues = appendLengthEncodedInteger(paramValues,
  770. uint64(len(v)),
  771. )
  772. paramValues = append(paramValues, v...)
  773. } else {
  774. if err := stmt.writeCommandLongData(i, []byte(v)); err != nil {
  775. return err
  776. }
  777. }
  778. case time.Time:
  779. paramTypes[i+i] = fieldTypeString
  780. paramTypes[i+i+1] = 0x00
  781. var val []byte
  782. if v.IsZero() {
  783. val = []byte("0000-00-00")
  784. } else {
  785. val = []byte(v.In(mc.cfg.loc).Format(timeFormat))
  786. }
  787. paramValues = appendLengthEncodedInteger(paramValues,
  788. uint64(len(val)),
  789. )
  790. paramValues = append(paramValues, val...)
  791. default:
  792. return fmt.Errorf("Can't convert type: %T", args[i])
  793. }
  794. }
  795. // Check if param values exceeded the available buffer
  796. // In that case we must build the data packet with the new values buffer
  797. if valuesCap != cap(paramValues) {
  798. data = append(data[:pos], paramValues...)
  799. mc.buf.buf = data
  800. }
  801. pos += len(paramValues)
  802. data = data[:pos]
  803. pktLen := pos - 4
  804. // packet header [4 bytes]
  805. data[0] = byte(pktLen)
  806. data[1] = byte(pktLen >> 8)
  807. data[2] = byte(pktLen >> 16)
  808. data[3] = mc.sequence
  809. // Convert nullMask to bytes
  810. for i, max := 0, (stmt.paramCount+7)>>3; i < max; i++ {
  811. data[i+14] = byte(nullMask >> uint(i<<3))
  812. }
  813. }
  814. return mc.writePacket(data)
  815. }
  816. // http://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html
  817. func (rows *binaryRows) readRow(dest []driver.Value) error {
  818. data, err := rows.mc.readPacket()
  819. if err != nil {
  820. return err
  821. }
  822. // packet indicator [1 byte]
  823. if data[0] != iOK {
  824. // EOF Packet
  825. if data[0] == iEOF && len(data) == 5 {
  826. return io.EOF
  827. }
  828. // Error otherwise
  829. return rows.mc.handleErrorPacket(data)
  830. }
  831. // NULL-bitmap, [(column-count + 7 + 2) / 8 bytes]
  832. pos := 1 + (len(dest)+7+2)>>3
  833. nullMask := data[1:pos]
  834. for i := range dest {
  835. // Field is NULL
  836. // (byte >> bit-pos) % 2 == 1
  837. if ((nullMask[(i+2)>>3] >> uint((i+2)&7)) & 1) == 1 {
  838. dest[i] = nil
  839. continue
  840. }
  841. // Convert to byte-coded string
  842. switch rows.columns[i].fieldType {
  843. case fieldTypeNULL:
  844. dest[i] = nil
  845. continue
  846. // Numeric Types
  847. case fieldTypeTiny:
  848. if rows.columns[i].flags&flagUnsigned != 0 {
  849. dest[i] = int64(data[pos])
  850. } else {
  851. dest[i] = int64(int8(data[pos]))
  852. }
  853. pos++
  854. continue
  855. case fieldTypeShort, fieldTypeYear:
  856. if rows.columns[i].flags&flagUnsigned != 0 {
  857. dest[i] = int64(binary.LittleEndian.Uint16(data[pos : pos+2]))
  858. } else {
  859. dest[i] = int64(int16(binary.LittleEndian.Uint16(data[pos : pos+2])))
  860. }
  861. pos += 2
  862. continue
  863. case fieldTypeInt24, fieldTypeLong:
  864. if rows.columns[i].flags&flagUnsigned != 0 {
  865. dest[i] = int64(binary.LittleEndian.Uint32(data[pos : pos+4]))
  866. } else {
  867. dest[i] = int64(int32(binary.LittleEndian.Uint32(data[pos : pos+4])))
  868. }
  869. pos += 4
  870. continue
  871. case fieldTypeLongLong:
  872. if rows.columns[i].flags&flagUnsigned != 0 {
  873. val := binary.LittleEndian.Uint64(data[pos : pos+8])
  874. if val > math.MaxInt64 {
  875. dest[i] = uint64ToString(val)
  876. } else {
  877. dest[i] = int64(val)
  878. }
  879. } else {
  880. dest[i] = int64(binary.LittleEndian.Uint64(data[pos : pos+8]))
  881. }
  882. pos += 8
  883. continue
  884. case fieldTypeFloat:
  885. dest[i] = float64(math.Float32frombits(binary.LittleEndian.Uint32(data[pos : pos+4])))
  886. pos += 4
  887. continue
  888. case fieldTypeDouble:
  889. dest[i] = math.Float64frombits(binary.LittleEndian.Uint64(data[pos : pos+8]))
  890. pos += 8
  891. continue
  892. // Length coded Binary Strings
  893. case fieldTypeDecimal, fieldTypeNewDecimal, fieldTypeVarChar,
  894. fieldTypeBit, fieldTypeEnum, fieldTypeSet, fieldTypeTinyBLOB,
  895. fieldTypeMediumBLOB, fieldTypeLongBLOB, fieldTypeBLOB,
  896. fieldTypeVarString, fieldTypeString, fieldTypeGeometry:
  897. var isNull bool
  898. var n int
  899. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  900. pos += n
  901. if err == nil {
  902. if !isNull {
  903. continue
  904. } else {
  905. dest[i] = nil
  906. continue
  907. }
  908. }
  909. return err
  910. // Date YYYY-MM-DD
  911. case fieldTypeDate, fieldTypeNewDate:
  912. num, isNull, n := readLengthEncodedInteger(data[pos:])
  913. pos += n
  914. if isNull {
  915. dest[i] = nil
  916. continue
  917. }
  918. if rows.mc.parseTime {
  919. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  920. } else {
  921. dest[i], err = formatBinaryDate(num, data[pos:])
  922. }
  923. if err == nil {
  924. pos += int(num)
  925. continue
  926. } else {
  927. return err
  928. }
  929. // Time [-][H]HH:MM:SS[.fractal]
  930. case fieldTypeTime:
  931. num, isNull, n := readLengthEncodedInteger(data[pos:])
  932. pos += n
  933. if num == 0 {
  934. if isNull {
  935. dest[i] = nil
  936. continue
  937. } else {
  938. dest[i] = []byte("00:00:00")
  939. continue
  940. }
  941. }
  942. var sign string
  943. if data[pos] == 1 {
  944. sign = "-"
  945. }
  946. switch num {
  947. case 8:
  948. dest[i] = []byte(fmt.Sprintf(
  949. sign+"%02d:%02d:%02d",
  950. uint16(data[pos+1])*24+uint16(data[pos+5]),
  951. data[pos+6],
  952. data[pos+7],
  953. ))
  954. pos += 8
  955. continue
  956. case 12:
  957. dest[i] = []byte(fmt.Sprintf(
  958. sign+"%02d:%02d:%02d.%06d",
  959. uint16(data[pos+1])*24+uint16(data[pos+5]),
  960. data[pos+6],
  961. data[pos+7],
  962. binary.LittleEndian.Uint32(data[pos+8:pos+12]),
  963. ))
  964. pos += 12
  965. continue
  966. default:
  967. return fmt.Errorf("Invalid TIME-packet length %d", num)
  968. }
  969. // Timestamp YYYY-MM-DD HH:MM:SS[.fractal]
  970. case fieldTypeTimestamp, fieldTypeDateTime:
  971. num, isNull, n := readLengthEncodedInteger(data[pos:])
  972. pos += n
  973. if isNull {
  974. dest[i] = nil
  975. continue
  976. }
  977. if rows.mc.parseTime {
  978. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  979. } else {
  980. dest[i], err = formatBinaryDateTime(num, data[pos:])
  981. }
  982. if err == nil {
  983. pos += int(num)
  984. continue
  985. } else {
  986. return err
  987. }
  988. // Please report if this happens!
  989. default:
  990. return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)
  991. }
  992. }
  993. return nil
  994. }