delta.go 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. package gig
  2. import (
  3. "bytes"
  4. "fmt"
  5. "io"
  6. "io/ioutil"
  7. "os"
  8. )
  9. //Delta represents a git delta representation. Either BaseRef
  10. //or BaseOff are valid fields, depending on its Type().
  11. type Delta struct {
  12. gitObject
  13. BaseRef SHA1
  14. BaseOff int64
  15. SizeSource int64
  16. SizeTarget int64
  17. pf *PackFile
  18. op DeltaOp
  19. err error
  20. }
  21. func readByte(r io.Reader) (byte, error) {
  22. var err error
  23. n := 0
  24. var b [1]byte
  25. for n != 1 && err == nil {
  26. n, err = r.Read(b[:])
  27. }
  28. if n != 1 {
  29. return 0, err
  30. }
  31. return b[0], nil
  32. }
  33. func parseDelta(obj gitObject) (*Delta, error) {
  34. delta := Delta{gitObject: obj}
  35. //all delta objects come from a PackFile and
  36. //therefore git.Source is must be a *packReader
  37. source := delta.source.(*packReader)
  38. delta.pf = source.fd
  39. var err error
  40. if obj.otype == ObjRefDelta {
  41. _, err = source.Read(delta.BaseRef[:])
  42. //TODO: check n?
  43. if err != nil {
  44. return nil, err
  45. }
  46. } else {
  47. off, err := readVarint(source)
  48. if err != nil {
  49. return nil, err
  50. }
  51. delta.BaseOff = source.start - off
  52. }
  53. err = delta.wrapSourceWithDeflate()
  54. if err != nil {
  55. return nil, err
  56. }
  57. delta.SizeSource, err = readVarSize(delta.source, 0)
  58. if err != nil {
  59. return nil, err
  60. }
  61. delta.SizeTarget, err = readVarSize(delta.source, 0)
  62. if err != nil {
  63. return nil, err
  64. }
  65. return &delta, nil
  66. }
  67. func readVarSize(r io.Reader, offset uint) (size int64, err error) {
  68. size = int64(0)
  69. b := byte(0x80)
  70. // [0111 1111 ... 1111] (int64) is biggest decode-able
  71. // value we get by shifting byte b = 0x7F [0111 1111]
  72. // left 8*7 = 56 times; the next attempt must overflow.
  73. for i := offset; b&0x80 != 0 && i < 57; i += 7 {
  74. b, err = readByte(r)
  75. if err != nil {
  76. return 0, fmt.Errorf("git: io error: %v", err)
  77. }
  78. size |= int64(b&0x7F) << i
  79. }
  80. // means i > 56, would overflow (see above).
  81. if b&0x80 != 0 {
  82. return 0, fmt.Errorf("int64 overflow")
  83. }
  84. return size, nil
  85. }
  86. func decodeInt(r io.Reader, b byte, l uint) (size int64, err error) {
  87. for i := uint(0); i < l; i++ {
  88. if b&(1<<i) != 0 {
  89. var d byte
  90. d, err = readByte(r)
  91. if err != nil {
  92. return
  93. }
  94. size |= int64(d) << (i * 8)
  95. }
  96. }
  97. return
  98. }
  99. func readVarint(r io.Reader) (int64, error) {
  100. b, err := readByte(r)
  101. if err != nil {
  102. return 0, fmt.Errorf("git: io error: %v", err)
  103. }
  104. size := int64(b & 0x7F)
  105. for b&0x80 != 0 {
  106. b, err = readByte(r)
  107. if err != nil {
  108. return 0, fmt.Errorf("git: io error: %v", err)
  109. }
  110. size++
  111. // [0000 0001 ... 0000] (int64)
  112. // ^ bit 0x38 (56)
  113. // shifting by 7 will shift the bit into the
  114. // sign bit of int64, i.e. we have overflow.
  115. if size > (1<<0x38)-1 {
  116. return 0, fmt.Errorf("int64 overflow")
  117. }
  118. size = (size << 7) + int64(b&0x7F)
  119. }
  120. return size, nil
  121. }
  122. //DeltaOpCode is the operation code for delta compression
  123. //instruction set.
  124. type DeltaOpCode byte
  125. //DeltaOpCode values.
  126. const (
  127. DeltaOpInsert = 1 //insert data from the delta data into dest
  128. DeltaOpCopy = 2 //copy data from the original source into dest
  129. )
  130. //DeltaOp represents the delta compression operation. Offset is
  131. //only valid for DeltaOpCopy operations.
  132. type DeltaOp struct {
  133. Op DeltaOpCode
  134. Size int64
  135. Offset int64
  136. }
  137. //Op returns the current operations
  138. func (d *Delta) Op() DeltaOp {
  139. return d.op
  140. }
  141. //Err retrieves the current error state, if any
  142. func (d *Delta) Err() error {
  143. if err := d.err; err != io.EOF {
  144. return err
  145. }
  146. return nil
  147. }
  148. //NextOp reads the next DeltaOp from the delta data stream.
  149. //Returns false when there are no operations left or on error;
  150. //use Err() to decide between the two cases.
  151. func (d *Delta) NextOp() bool {
  152. if d.err != nil {
  153. return false
  154. }
  155. b, err := readByte(d.source)
  156. if err != nil {
  157. return false
  158. }
  159. if b&0x80 != 0 {
  160. d.op.Op = DeltaOpCopy
  161. op := b & 0x7F
  162. d.op.Offset, d.err = decodeInt(d.source, op, 4)
  163. if d.err != nil {
  164. return false
  165. }
  166. d.op.Size, d.err = decodeInt(d.source, op>>4, 3)
  167. if d.err != nil {
  168. return false
  169. }
  170. if d.op.Size == 0 {
  171. d.op.Size = 0x10000
  172. }
  173. } else if n := b; n > 0 {
  174. d.op.Op = DeltaOpInsert
  175. d.op.Size = int64(n)
  176. } else {
  177. d.err = fmt.Errorf("git: unknown delta op code")
  178. return false
  179. }
  180. return true
  181. }
  182. //Patch applies the delta data onto r and writes the result to w.
  183. func (d *Delta) Patch(r io.ReadSeeker, w io.Writer) error {
  184. for d.NextOp() {
  185. op := d.Op()
  186. switch op.Op {
  187. case DeltaOpCopy:
  188. _, err := r.Seek(op.Offset, os.SEEK_SET)
  189. if err != nil {
  190. return err
  191. }
  192. _, err = io.CopyN(w, r, op.Size)
  193. if err != nil {
  194. return err
  195. }
  196. case DeltaOpInsert:
  197. _, err := io.CopyN(w, d.source, op.Size)
  198. if err != nil {
  199. return err
  200. }
  201. }
  202. }
  203. return d.Err()
  204. }
  205. //SkipOp prepares the delta stream to move to the next operation
  206. //without actually carrying out the delta operation. Useful for
  207. //printing the delta stream.
  208. func (d *Delta) SkipOp() {
  209. op := d.Op()
  210. if op.Op == DeltaOpInsert {
  211. _, d.err = io.CopyN(ioutil.Discard, d.source, op.Size)
  212. }
  213. }
  214. //WriteTo would write the object to disk in the git object
  215. //representation. It is not NOT IMPLEMENTED for the delta
  216. //object.
  217. func (d *Delta) WriteTo(w io.Writer) (int64, error) {
  218. return 0, fmt.Errorf("WriteTo not implemented for Delta")
  219. }
  220. type deltaChain struct {
  221. baseObj gitObject
  222. baseOff int64
  223. links []Delta
  224. }
  225. func (c *deltaChain) Len() int {
  226. return len(c.links)
  227. }
  228. type objectSource interface {
  229. openRawObject(id SHA1) (gitObject, error)
  230. }
  231. func buildDeltaChain(d *Delta, s objectSource) (*deltaChain, error) {
  232. var chain deltaChain
  233. var err error
  234. for err == nil {
  235. chain.links = append(chain.links, *d)
  236. var obj gitObject
  237. if d.otype == ObjRefDelta {
  238. obj, err = s.openRawObject(d.BaseRef)
  239. } else {
  240. obj, err = d.pf.readRawObject(d.BaseOff)
  241. }
  242. if err != nil {
  243. break
  244. }
  245. if IsStandardObject(obj.otype) {
  246. chain.baseObj = obj
  247. chain.baseOff = d.BaseOff
  248. break
  249. } else if !IsDeltaObject(obj.otype) {
  250. err = fmt.Errorf("git: unexpected object type in delta chain")
  251. break
  252. }
  253. d, err = parseDelta(obj)
  254. }
  255. if err != nil {
  256. //cleanup
  257. return nil, err
  258. }
  259. return &chain, nil
  260. }
  261. func (c *deltaChain) resolve() (Object, error) {
  262. ibuf := bytes.NewBuffer(make([]byte, 0, c.baseObj.Size()))
  263. n, err := io.Copy(ibuf, c.baseObj.source)
  264. if err != nil {
  265. return nil, err
  266. }
  267. if n != c.baseObj.Size() {
  268. return nil, io.ErrUnexpectedEOF
  269. }
  270. obuf := bytes.NewBuffer(make([]byte, 0, c.baseObj.Size()))
  271. for i := len(c.links); i > 0; i-- {
  272. lk := c.links[i-1]
  273. if lk.SizeTarget > int64(^uint(0)>>1) {
  274. return nil, fmt.Errorf("git: target to large for delta unpatching")
  275. }
  276. obuf.Grow(int(lk.SizeTarget))
  277. obuf.Truncate(0)
  278. err = lk.Patch(bytes.NewReader(ibuf.Bytes()), obuf)
  279. if err != nil {
  280. return nil, err
  281. }
  282. if lk.SizeTarget != int64(obuf.Len()) {
  283. return nil, fmt.Errorf("git: size mismatch while patching delta object")
  284. }
  285. obuf, ibuf = ibuf, obuf
  286. }
  287. //ibuf is holding the data
  288. obj := gitObject{c.baseObj.otype, int64(ibuf.Len()), ioutil.NopCloser(ibuf)}
  289. return parseObject(obj)
  290. }