You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/10/05 03:34:49 UTC
[GitHub] ccollins476ad closed pull request #217: sysdown: generate package
shutdown function
ccollins476ad closed pull request #217: sysdown: generate package shutdown function
URL: https://github.com/apache/mynewt-newt/pull/217
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/newt/builder/targetbuild.go b/newt/builder/targetbuild.go
index 1c2f8ba7..537bfd50 100644
--- a/newt/builder/targetbuild.go
+++ b/newt/builder/targetbuild.go
@@ -45,6 +45,7 @@ import (
"mynewt.apache.org/newt/newt/resolve"
"mynewt.apache.org/newt/newt/symbol"
"mynewt.apache.org/newt/newt/syscfg"
+ "mynewt.apache.org/newt/newt/sysdown"
"mynewt.apache.org/newt/newt/sysinit"
"mynewt.apache.org/newt/newt/target"
"mynewt.apache.org/newt/newt/toolchain"
@@ -237,6 +238,20 @@ func (t *TargetBuilder) generateSysinit() error {
return nil
}
+func (t *TargetBuilder) generateSysdown() error {
+ if err := t.ensureResolved(); err != nil {
+ return err
+ }
+
+ srcDir := GeneratedSrcDir(t.target.Name())
+
+ lpkgs := resolve.RpkgSliceToLpkgSlice(t.res.AppSet.Rpkgs)
+ sysdown.EnsureWritten(lpkgs, srcDir,
+ pkg.ShortName(t.target.Package()))
+
+ return nil
+}
+
func (t *TargetBuilder) generateFlashMap() error {
return t.bspPkg.FlashMap.EnsureWritten(
GeneratedSrcDir(t.target.Name()),
@@ -249,6 +264,10 @@ func (t *TargetBuilder) generateCode() error {
return err
}
+ if err := t.generateSysdown(); err != nil {
+ return err
+ }
+
if err := t.generateFlashMap(); err != nil {
return err
}
diff --git a/newt/pkg/localpackage.go b/newt/pkg/localpackage.go
index 6927b382..e49d184b 100644
--- a/newt/pkg/localpackage.go
+++ b/newt/pkg/localpackage.go
@@ -65,6 +65,10 @@ type LocalPackage struct {
// sysinit C file.
init map[string]int
+ // Package shutdown function name and stage. These are used to generate
+ // the sysdown C file.
+ downFuncs map[string]int
+
// Extra package-specific settings that don't come from syscfg. For
// example, SELFTEST gets set when the newt test command is used.
injectedSettings map[string]string
@@ -87,6 +91,7 @@ func NewLocalPackage(r *repo.Repo, pkgDir string) *LocalPackage {
repo: r,
basePath: filepath.ToSlash(filepath.Clean(pkgDir)),
init: map[string]int{},
+ downFuncs: map[string]int{},
injectedSettings: map[string]string{},
}
return pkg
@@ -361,13 +366,24 @@ func (pkg *LocalPackage) Load() error {
}
pkg.init[name] = int(stage)
}
+
+ // Backwards compatibility: allow old sysinit notation.
initFnName := pkg.PkgY.GetValString("pkg.init_function", nil)
initStage := pkg.PkgY.GetValInt("pkg.init_stage", nil)
-
if initFnName != "" {
pkg.init[initFnName] = initStage
}
+ down := pkg.PkgY.GetValStringMapString("pkg.down", nil)
+ for name, stageStr := range down {
+ stage, err := strconv.ParseInt(stageStr, 10, 64)
+ if err != nil {
+ return util.NewNewtError(fmt.Sprintf("Parsing pkg %s config: %s",
+ pkg.FullName(), err.Error()))
+ }
+ pkg.downFuncs[name] = int(stage)
+ }
+
// Read the package description from the file
pkg.desc, err = pkg.readDesc(pkg.PkgY)
if err != nil {
@@ -391,6 +407,10 @@ func (pkg *LocalPackage) Init() map[string]int {
return pkg.init
}
+func (pkg *LocalPackage) DownFuncs() map[string]int {
+ return pkg.downFuncs
+}
+
func (pkg *LocalPackage) InjectedSettings() map[string]string {
return pkg.injectedSettings
}
diff --git a/newt/stage/stage.go b/newt/stage/stage.go
new file mode 100644
index 00000000..ee2deadd
--- /dev/null
+++ b/newt/stage/stage.go
@@ -0,0 +1,204 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// stage - utility for generating C code consisting of a sequence of function
+// calls ordered by stage number.
+//
+// This package is used by sysinit and sysdown.
+
+package stage
+
+import (
+ "fmt"
+ "io"
+ "io/ioutil"
+ "os"
+ "path/filepath"
+ "sort"
+ "strings"
+
+ log "github.com/Sirupsen/logrus"
+
+ "mynewt.apache.org/newt/newt/pkg"
+ "mynewt.apache.org/newt/util"
+)
+
+type StageFunc struct {
+ Stage int
+ Name string
+ ReturnType string
+ ArgList string
+ Pkg *pkg.LocalPackage
+}
+
+type stageFuncSorter struct {
+ // Used in logging; either "sysinit" or "sysdown".
+ funcType string
+ // Array of functions to be sorted.
+ fns []StageFunc
+}
+
+func (s stageFuncSorter) Len() int {
+ return len(s.fns)
+}
+
+func (s stageFuncSorter) Swap(i, j int) {
+ s.fns[i], s.fns[j] = s.fns[j], s.fns[i]
+}
+
+func (s stageFuncSorter) Less(i, j int) bool {
+ a := s.fns[i]
+ b := s.fns[j]
+
+ // 1: Sort by stage number.
+ if a.Stage < b.Stage {
+ return true
+ } else if b.Stage < a.Stage {
+ return false
+ }
+
+ // 2: Sort by function name.
+ switch strings.Compare(a.Name, b.Name) {
+ case -1:
+ return true
+ case 1:
+ return false
+ }
+
+ // Same stage and function name?
+ log.Warnf("Warning: Identical %s functions detected: %s",
+ s.funcType, a.Name)
+
+ return true
+}
+
+// SortStageFuncs performs an in-place sort of the provided StageFunc slice.
+func SortStageFuncs(unsorted []StageFunc, funcType string) {
+ s := stageFuncSorter{
+ funcType: funcType,
+ fns: unsorted,
+ }
+
+ sort.Sort(s)
+}
+
+func (f *StageFunc) ReturnTypeString() string {
+ if f.ReturnType == "" {
+ return "void"
+ } else {
+ return f.ReturnType
+ }
+}
+
+func (f *StageFunc) ArgListString() string {
+ if f.ArgList == "" {
+ return "void"
+ } else {
+ return f.ArgList
+ }
+}
+
+// WriteCalls emits C code: a list of function prototypes corresponding to the
+// provided slice of stage functions.
+func WritePrototypes(sortedFns []StageFunc, w io.Writer) {
+ for _, f := range sortedFns {
+ fmt.Fprintf(w, "%s %s(%s);\n",
+ f.ReturnTypeString(), f.Name, f.ArgListString())
+ }
+}
+
+// WriteCalls emits C code: a sequence of function calls corresponding to the
+// provided slice of stage functions.
+func WriteCalls(sortedFuncs []StageFunc, argList string, w io.Writer) {
+ prevStage := -1
+ dupCount := 0
+
+ for i, f := range sortedFuncs {
+ if f.Stage != prevStage {
+ prevStage = f.Stage
+ dupCount = 0
+
+ if i != 0 {
+ fmt.Fprintf(w, "\n")
+ }
+ fmt.Fprintf(w, " /*** Stage %d */\n", f.Stage)
+ } else {
+ dupCount += 1
+ }
+
+ fmt.Fprintf(w, " /* %d.%d: %s (%s) */\n",
+ f.Stage, dupCount, f.Name, f.Pkg.Name())
+ fmt.Fprintf(w, " %s(%s);\n", f.Name, argList)
+ }
+}
+
+// WriteArr emits C code: an array body of function pointers represented by the
+// supplied slice. The caller must 1) write the array declaration before
+// calling this function, and 2) write "};" afterwards.
+func WriteArr(sortedFuncs []StageFunc, w io.Writer) {
+ prevStage := -1
+ dupCount := 0
+
+ for i, f := range sortedFuncs {
+ if f.Stage != prevStage {
+ prevStage = f.Stage
+ dupCount = 0
+
+ if i != 0 {
+ fmt.Fprintf(w, "\n")
+ }
+ fmt.Fprintf(w, " /*** Stage %d */\n", f.Stage)
+ } else {
+ dupCount += 1
+ }
+
+ fmt.Fprintf(w, " /* %d.%d: %s (%s) */\n",
+ f.Stage, dupCount, f.Name, f.Pkg.Name())
+ fmt.Fprintf(w, " %s,\n", f.Name)
+ }
+ fmt.Fprintf(w, "\n")
+ fmt.Fprintf(w, " /*** Array terminator. */\n")
+ fmt.Fprintf(w, " 0\n")
+}
+
+// EnsureWritten writes the specified file if its contents differ from those of
+// the supplied byte slice.
+func EnsureWritten(path string, contents []byte) error {
+ unchanged, err := util.FileContains(contents, path)
+ if err != nil {
+ return err
+ }
+
+ if unchanged {
+ log.Debugf("file unchanged; not writing src file (%s).", path)
+ return nil
+ }
+
+ log.Debugf("file changed; writing src file (%s).", path)
+
+ if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
+ return util.NewNewtError(err.Error())
+ }
+
+ if err := ioutil.WriteFile(path, contents, 0644); err != nil {
+ return util.NewNewtError(err.Error())
+ }
+
+ return nil
+}
diff --git a/newt/sysdown/sysdown.go b/newt/sysdown/sysdown.go
new file mode 100644
index 00000000..121d3560
--- /dev/null
+++ b/newt/sysdown/sysdown.go
@@ -0,0 +1,78 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package sysdown
+
+import (
+ "bytes"
+ "fmt"
+ "io"
+
+ "mynewt.apache.org/newt/newt/newtutil"
+ "mynewt.apache.org/newt/newt/pkg"
+ "mynewt.apache.org/newt/newt/stage"
+)
+
+// downFuncs collects the sysdown functions corresponding to the provided
+// packages.
+func downFuncs(pkgs []*pkg.LocalPackage) []stage.StageFunc {
+ fns := make([]stage.StageFunc, 0, len(pkgs))
+ for _, p := range pkgs {
+ downMap := p.DownFuncs()
+ for name, stageNum := range downMap {
+ fn := stage.StageFunc{
+ Name: name,
+ Stage: stageNum,
+ ReturnType: "int",
+ ArgList: "int reason",
+ Pkg: p,
+ }
+ fns = append(fns, fn)
+ }
+ }
+
+ return fns
+}
+
+func sortedDownFuncs(pkgs []*pkg.LocalPackage) []stage.StageFunc {
+ fns := downFuncs(pkgs)
+ stage.SortStageFuncs(fns, "sysdown")
+ return fns
+}
+
+func write(pkgs []*pkg.LocalPackage, w io.Writer) {
+ fmt.Fprintf(w, newtutil.GeneratedPreamble())
+
+ fns := sortedDownFuncs(pkgs)
+ stage.WritePrototypes(fns, w)
+
+ fmt.Fprintf(w, "\nint (* const sysdown_cbs[])(int reason) = {\n")
+ stage.WriteArr(fns, w)
+ fmt.Fprintf(w, "};\n")
+}
+
+func EnsureWritten(pkgs []*pkg.LocalPackage, srcDir string,
+ targetName string) error {
+
+ buf := bytes.Buffer{}
+ write(pkgs, &buf)
+
+ path := fmt.Sprintf("%s/%s-sysdown.c", srcDir, targetName)
+ return stage.EnsureWritten(path, buf.Bytes())
+}
diff --git a/newt/sysinit/sysinit.go b/newt/sysinit/sysinit.go
index 4071a096..98e7fc65 100644
--- a/newt/sysinit/sysinit.go
+++ b/newt/sysinit/sysinit.go
@@ -23,125 +23,33 @@ import (
"bytes"
"fmt"
"io"
- "io/ioutil"
- "os"
- "path/filepath"
- "sort"
- "strings"
-
- log "github.com/Sirupsen/logrus"
"mynewt.apache.org/newt/newt/newtutil"
"mynewt.apache.org/newt/newt/pkg"
- "mynewt.apache.org/newt/util"
+ "mynewt.apache.org/newt/newt/stage"
)
-type initFunc struct {
- stage int
- name string
- pkg *pkg.LocalPackage
-}
-
-func buildStageMap(pkgs []*pkg.LocalPackage) map[int][]*initFunc {
- sm := map[int][]*initFunc{}
-
- for _, p := range pkgs {
- for name, stage := range p.Init() {
- initFunc := &initFunc{
- stage: stage,
- name: name,
- pkg: p,
- }
- sm[stage] = append(sm[stage], initFunc)
- }
- }
-
- return sm
-}
-
-type initFuncSorter struct {
- fns []*initFunc
-}
-
-func (s initFuncSorter) Len() int {
- return len(s.fns)
-}
-func (s initFuncSorter) Swap(i, j int) {
- s.fns[i], s.fns[j] = s.fns[j], s.fns[i]
-}
-func (s initFuncSorter) Less(i, j int) bool {
- a := s.fns[i]
- b := s.fns[j]
-
- // 1: Sort by stage number.
- if a.stage < b.stage {
- return true
- } else if b.stage < a.stage {
- return false
- }
-
- // 2: Sort by function name.
- switch strings.Compare(a.name, b.name) {
- case -1:
- return true
- case 1:
- return false
- }
-
- // Same stage and function name?
- log.Warnf("Warning: Identical sysinit functions detected: %s", a.name)
- return true
-}
-
-func sortedInitFuncs(pkgs []*pkg.LocalPackage) []*initFunc {
- sorter := initFuncSorter{
- fns: make([]*initFunc, 0, len(pkgs)),
- }
-
+func initFuncs(pkgs []*pkg.LocalPackage) []stage.StageFunc {
+ fns := make([]stage.StageFunc, 0, len(pkgs))
for _, p := range pkgs {
initMap := p.Init()
- for name, stage := range initMap {
- fn := &initFunc{
- name: name,
- stage: stage,
- pkg: p,
+ for name, stageNum := range initMap {
+ fn := stage.StageFunc{
+ Name: name,
+ Stage: stageNum,
+ Pkg: p,
}
- sorter.fns = append(sorter.fns, fn)
+ fns = append(fns, fn)
}
}
- sort.Sort(sorter)
- return sorter.fns
-}
-
-func writePrototypes(pkgs []*pkg.LocalPackage, w io.Writer) {
- sortedFns := sortedInitFuncs(pkgs)
- for _, f := range sortedFns {
- fmt.Fprintf(w, "void %s(void);\n", f.name)
- }
+ return fns
}
-func writeCalls(sortedInitFuncs []*initFunc, w io.Writer) {
- prevStage := -1
- dupCount := 0
-
- for i, f := range sortedInitFuncs {
- if f.stage != prevStage {
- prevStage = f.stage
- dupCount = 0
-
- if i != 0 {
- fmt.Fprintf(w, "\n")
- }
- fmt.Fprintf(w, " /*** Stage %d */\n", f.stage)
- } else {
- dupCount += 1
- }
-
- fmt.Fprintf(w, " /* %d.%d: %s (%s) */\n",
- f.stage, dupCount, f.name, f.pkg.Name())
- fmt.Fprintf(w, " %s();\n", f.name)
- }
+func sortedInitFuncs(pkgs []*pkg.LocalPackage) []stage.StageFunc {
+ fns := initFuncs(pkgs)
+ stage.SortStageFuncs(fns, "sysinit")
+ return fns
}
func write(pkgs []*pkg.LocalPackage, isLoader bool,
@@ -155,7 +63,9 @@ func write(pkgs []*pkg.LocalPackage, isLoader bool,
fmt.Fprintf(w, "#if !SPLIT_LOADER\n\n")
}
- writePrototypes(pkgs, w)
+ fns := sortedInitFuncs(pkgs)
+
+ stage.WritePrototypes(fns, w)
var fnName string
if isLoader {
@@ -167,27 +77,12 @@ func write(pkgs []*pkg.LocalPackage, isLoader bool,
fmt.Fprintf(w, "\n")
fmt.Fprintf(w, "void\n%s(void)\n{\n", fnName)
- writeCalls(sortedInitFuncs(pkgs), w)
+ stage.WriteCalls(fns, "", w)
fmt.Fprintf(w, "}\n\n")
fmt.Fprintf(w, "#endif\n")
}
-func writeRequired(contents []byte, path string) (bool, error) {
- oldSrc, err := ioutil.ReadFile(path)
- if err != nil {
- if os.IsNotExist(err) {
- // File doesn't exist; write required.
- return true, nil
- }
-
- return true, util.NewNewtError(err.Error())
- }
-
- rc := bytes.Compare(oldSrc, contents)
- return rc != 0, nil
-}
-
func EnsureWritten(pkgs []*pkg.LocalPackage, srcDir string, targetName string,
isLoader bool) error {
@@ -201,25 +96,5 @@ func EnsureWritten(pkgs []*pkg.LocalPackage, srcDir string, targetName string,
path = fmt.Sprintf("%s/%s-sysinit-app.c", srcDir, targetName)
}
- writeReqd, err := writeRequired(buf.Bytes(), path)
- if err != nil {
- return err
- }
-
- if !writeReqd {
- log.Debugf("sysinit unchanged; not writing src file (%s).", path)
- return nil
- }
-
- log.Debugf("sysinit changed; writing src file (%s).", path)
-
- if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
- return util.NewNewtError(err.Error())
- }
-
- if err := ioutil.WriteFile(path, buf.Bytes(), 0644); err != nil {
- return util.NewNewtError(err.Error())
- }
-
- return nil
+ return stage.EnsureWritten(path, buf.Bytes())
}
diff --git a/util/util.go b/util/util.go
index e8486429..d3abfc3a 100644
--- a/util/util.go
+++ b/util/util.go
@@ -696,3 +696,20 @@ func StringMapStringToItfMapItf(
return imi
}
+
+// FileContains indicates whether the specified file's contents are equal to
+// the provided byte slice.
+func FileContains(contents []byte, path string) (bool, error) {
+ oldSrc, err := ioutil.ReadFile(path)
+ if err != nil {
+ if os.IsNotExist(err) {
+ // File doesn't exist; contents aren't equal.
+ return false, nil
+ }
+
+ return false, NewNewtError(err.Error())
+ }
+
+ rc := bytes.Compare(oldSrc, contents)
+ return rc == 0, nil
+}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services