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
  30         "go.cypherpunks.ru/recfile"
  31         "lukechampine.com/blake3"
  32 )
  33
  34 var (
  35         DirPrefix string
  36         DepCwd    string
  37
  38         ErrBadRecFormat = errors.New("invalid format of .rec")
  39 )
  40
  41 func recfileWrite(fdDep io.StringWriter, fields ...recfile.Field) error {
  42         w := recfile.NewWriter(fdDep)
  43         if _, err := w.RecordStart(); err != nil {
  44                 return err
  45         }
  46         if _, err := w.WriteFields(fields...); err != nil {
  47                 return err
  48         }
  49         return nil
  50 }
  51
  52 func ifcreate(fdDep *os.File, tgt string) error {
  53         tracef(CDebug, "ifcreate: %s <- %s", fdDep.Name(), tgt)
  54         return recfileWrite(
  55                 fdDep,
  56                 recfile.Field{Name: "Type", Value: DepTypeIfcreate},
  57                 recfile.Field{Name: "Target", Value: tgt},
  58         )
  59 }
  60
  61 func always(fdDep *os.File) error {
  62         tracef(CDebug, "always: %s", fdDep.Name())
  63         return recfileWrite(fdDep, recfile.Field{Name: "Type", Value: DepTypeAlways})
  64 }
  65
  66 func stamp(fdDep, src *os.File) error {
  67         var hsh string
  68         hsh, err := fileHash(src)
  69         if err != nil {
  70                 return err
  71         }
  72         tracef(CDebug, "stamp: %s <- %s", fdDep.Name(), hsh)
  73         return recfileWrite(
  74                 fdDep,
  75                 recfile.Field{Name: "Type", Value: DepTypeStamp},
  76                 recfile.Field{Name: "Hash", Value: hsh},
  77         )
  78 }
  79
  80 func fileHash(fd *os.File) (string, error) {
  81         h := blake3.New(32, nil)
  82         if _, err := io.Copy(h, bufio.NewReader(fd)); err != nil {
  83                 return "", err
  84         }
  85         return hex.EncodeToString(h.Sum(nil)), nil
  86 }
  87
  88 func depWrite(fdDep *os.File, cwd, tgt, hsh string) error {
  89         tracef(CDebug, "ifchange: %s <- %s", fdDep.Name(), tgt)
  90         fd, err := os.Open(path.Join(cwd, tgt))
  91         if err != nil {
  92                 return ErrLine(err)
  93         }
  94         defer fd.Close()
  95         fi, err := fd.Stat()
  96         if err != nil {
  97                 return err
  98         }
  99         if fi.IsDir() {
 100                 return nil
 101         }
 102         inode, err := inodeFromFileByFd(fd)
 103         if err != nil {
 104                 return err
 105         }
 106         if hsh == "" {
 107                 hsh, err = fileHash(fd)
 108                 if err != nil {
 109                         return ErrLine(err)
 110                 }
 111         }
 112         fields := []recfile.Field{
 113                 {Name: "Type", Value: DepTypeIfchange},
 114                 {Name: "Target", Value: tgt},
 115                 {Name: "Hash", Value: hsh},
 116         }
 117         fields = append(fields, inode.RecfileFields()...)
 118         return recfileWrite(fdDep, fields...)
 119 }
 120
 121 func depsWrite(fdDep *os.File, tgts []string) error {
 122         if fdDep == nil {
 123                 tracef(CDebug, "no opened fdDep: %s", tgts)
 124                 return nil
 125         }
 126         var err error
 127         for _, tgt := range tgts {
 128                 tgtAbs := mustAbs(tgt)
 129                 cwd := Cwd
 130                 if DepCwd != "" && Cwd != DepCwd {
 131                         cwd = DepCwd
 132                 }
 133                 tgtDir := path.Join(cwd, DirPrefix)
 134                 tgtRel := mustRel(tgtDir, tgtAbs)
 135                 if _, errStat := os.Stat(tgt); errStat == nil {
 136                         err = ErrLine(depWrite(fdDep, tgtDir, tgtRel, ""))
 137                 } else {
 138                         tracef(CDebug, "ifchange: %s <- %s (non-existing)", fdDep.Name(), tgtRel)
 139                         fields := []recfile.Field{
 140                                 {Name: "Type", Value: DepTypeIfchange},
 141                                 {Name: "Target", Value: tgtRel},
 142                         }
 143                         inodeDummy := Inode{}
 144                         fields = append(fields, inodeDummy.RecfileFields()...)
 145                         err = ErrLine(recfileWrite(fdDep, fields...))
 146                 }
 147                 if err != nil {
 148                         return err
 149                 }
 150         }
 151         return nil
 152 }
 153
 154 type DepInfo struct {
 155         build     string
 156         always    bool
 157         stamp     string
 158         ifcreates []string
 159         ifchanges []map[string]string
 160 }
 161
 162 func depRead(fdDep io.Reader) (*DepInfo, error) {
 163         r := recfile.NewReader(fdDep)
 164         m, err := r.NextMap()
 165         if err != nil {
 166                 return nil, err
 167         }
 168         depInfo := DepInfo{}
 169         b := m["Build"]
 170         if b == "" {
 171                 return nil, errors.New(".rec missing Build:")
 172         }
 173         depInfo.build = b
 174         for {
 175                 m, err := r.NextMap()
 176                 if err != nil {
 177                         if errors.Is(err, io.EOF) {
 178                                 break
 179                         }
 180                         return nil, err
 181                 }
 182                 switch m["Type"] {
 183                 case DepTypeAlways:
 184                         depInfo.always = true
 185                 case DepTypeIfcreate:
 186                         dep := m["Target"]
 187                         if dep == "" {
 188                                 return nil, ErrBadRecFormat
 189                         }
 190                         depInfo.ifcreates = append(depInfo.ifcreates, dep)
 191                 case DepTypeIfchange:
 192                         delete(m, "Type")
 193                         depInfo.ifchanges = append(depInfo.ifchanges, m)
 194                 case DepTypeStamp:
 195                         hsh := m["Hash"]
 196                         if hsh == "" {
 197                                 return nil, ErrBadRecFormat
 198                         }
 199                         depInfo.stamp = hsh
 200                 default:
 201                         return nil, ErrBadRecFormat
 202                 }
 203         }
 204         return &depInfo, nil
 205 }