dep.go

   1 /*
   2 goredo -- djb's redo implementation on pure Go
   3 Copyright (C) 2020-2023 Sergey Matveev <stargrave@stargrave.org>
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation, version 3 of the License.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 // Dependencies saver
  19
  20 package main
  21
  22 import (
  23         "bufio"
  24         "encoding/hex"
  25         "errors"
  26         "io"
  27         "os"
  28         "path"
  29         "path/filepath"
  30
  31         "go.cypherpunks.ru/recfile"
  32         "lukechampine.com/blake3"
  33 )
  34
  35 var (
  36         DirPrefix string
  37         DepCwd    string
  38
  39         ErrBadRecFormat = errors.New("invalid format of .rec")
  40 )
  41
  42 func recfileWrite(fdDep io.StringWriter, fields ...recfile.Field) error {
  43         w := recfile.NewWriter(fdDep)
  44         if _, err := w.RecordStart(); err != nil {
  45                 return err
  46         }
  47         if _, err := w.WriteFields(fields...); err != nil {
  48                 return err
  49         }
  50         return nil
  51 }
  52
  53 func ifcreate(fdDep *os.File, tgt string) error {
  54         tracef(CDebug, "ifcreate: %s <- %s", fdDep.Name(), tgt)
  55         return recfileWrite(
  56                 fdDep,
  57                 recfile.Field{Name: "Type", Value: DepTypeIfcreate},
  58                 recfile.Field{Name: "Target", Value: tgt},
  59         )
  60 }
  61
  62 func always(fdDep *os.File) error {
  63         tracef(CDebug, "always: %s", fdDep.Name())
  64         return recfileWrite(fdDep, recfile.Field{Name: "Type", Value: DepTypeAlways})
  65 }
  66
  67 func stamp(fdDep, src *os.File) error {
  68         var hsh string
  69         hsh, err := fileHash(src)
  70         if err != nil {
  71                 return err
  72         }
  73         tracef(CDebug, "stamp: %s <- %s", fdDep.Name(), hsh)
  74         return recfileWrite(
  75                 fdDep,
  76                 recfile.Field{Name: "Type", Value: DepTypeStamp},
  77                 recfile.Field{Name: "Hash", Value: hsh},
  78         )
  79 }
  80
  81 func fileHash(fd *os.File) (string, error) {
  82         h := blake3.New(32, nil)
  83         if _, err := io.Copy(h, bufio.NewReader(fd)); err != nil {
  84                 return "", err
  85         }
  86         return hex.EncodeToString(h.Sum(nil)), nil
  87 }
  88
  89 func depWrite(fdDep *os.File, cwd, tgt, hsh string) error {
  90         tracef(CDebug, "ifchange: %s <- %s", fdDep.Name(), tgt)
  91         fd, err := os.Open(path.Join(cwd, tgt))
  92         if err != nil {
  93                 return err
  94         }
  95         defer fd.Close()
  96         fi, err := fd.Stat()
  97         if err != nil {
  98                 return err
  99         }
 100         if fi.IsDir() {
 101                 return nil
 102         }
 103         inode, err := inodeFromFileByFd(fd)
 104         if err != nil {
 105                 return err
 106         }
 107         if hsh == "" {
 108                 hsh, err = fileHash(fd)
 109                 if err != nil {
 110                         return err
 111                 }
 112         }
 113         fields := []recfile.Field{
 114                 {Name: "Type", Value: DepTypeIfchange},
 115                 {Name: "Target", Value: tgt},
 116                 {Name: "Hash", Value: hsh},
 117         }
 118         fields = append(fields, inode.RecfileFields()...)
 119         return recfileWrite(fdDep, fields...)
 120 }
 121
 122 func depsWrite(fdDep *os.File, tgts []string) error {
 123         if fdDep == nil {
 124                 tracef(CDebug, "no opened fdDep: %s", tgts)
 125                 return nil
 126         }
 127         for _, tgt := range tgts {
 128                 tgtAbs, err := filepath.Abs(tgt)
 129                 if err != nil {
 130                         panic(err)
 131                 }
 132                 cwd := Cwd
 133                 if DepCwd != "" && Cwd != DepCwd {
 134                         cwd = DepCwd
 135                 }
 136                 tgtDir := path.Join(cwd, DirPrefix)
 137                 tgtRel, err := filepath.Rel(tgtDir, tgtAbs)
 138                 if err != nil {
 139                         panic(err)
 140                 }
 141                 if _, errStat := os.Stat(tgt); errStat == nil {
 142                         err = depWrite(fdDep, tgtDir, tgtRel, "")
 143                 } else {
 144                         tracef(CDebug, "ifchange: %s <- %s (non-existing)", fdDep.Name(), tgtRel)
 145                         fields := []recfile.Field{
 146                                 {Name: "Type", Value: DepTypeIfchange},
 147                                 {Name: "Target", Value: tgtRel},
 148                         }
 149                         inodeDummy := Inode{}
 150                         fields = append(fields, inodeDummy.RecfileFields()...)
 151                         err = recfileWrite(fdDep, fields...)
 152                 }
 153                 if err != nil {
 154                         return err
 155                 }
 156         }
 157         return nil
 158 }
 159
 160 type DepInfo struct {
 161         build     string
 162         always    bool
 163         stamp     string
 164         ifcreates []string
 165         ifchanges []map[string]string
 166 }
 167
 168 func depRead(fdDep io.Reader) (*DepInfo, error) {
 169         r := recfile.NewReader(fdDep)
 170         m, err := r.NextMap()
 171         if err != nil {
 172                 return nil, err
 173         }
 174         depInfo := DepInfo{}
 175         b := m["Build"]
 176         if b == "" {
 177                 return nil, errors.New(".rec missing Build:")
 178         }
 179         depInfo.build = b
 180         for {
 181                 m, err := r.NextMap()
 182                 if err != nil {
 183                         if errors.Is(err, io.EOF) {
 184                                 break
 185                         }
 186                         return nil, err
 187                 }
 188                 switch m["Type"] {
 189                 case DepTypeAlways:
 190                         depInfo.always = true
 191                 case DepTypeIfcreate:
 192                         dep := m["Target"]
 193                         if dep == "" {
 194                                 return nil, ErrBadRecFormat
 195                         }
 196                         depInfo.ifcreates = append(depInfo.ifcreates, dep)
 197                 case DepTypeIfchange:
 198                         delete(m, "Type")
 199                         depInfo.ifchanges = append(depInfo.ifchanges, m)
 200                 case DepTypeStamp:
 201                         hsh := m["Hash"]
 202                         if hsh == "" {
 203                                 return nil, ErrBadRecFormat
 204                         }
 205                         depInfo.stamp = hsh
 206                 default:
 207                         return nil, ErrBadRecFormat
 208                 }
 209         }
 210         return &depInfo, nil
 211 }