Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b98d3bcf authored by Colin Cross's avatar Colin Cross
Browse files

Wait for ninja proto processing to finish when exiting 

Wait for the ninja proto processing goroutine to notice the fifo
has closed and exit before continuing.

Test: m nothing
Change-Id: I8cf5f3b8bf6a91496c6d2bbbd3e811eb7f0c9d21
parent f8d3be9c

ui/build/ninja.go

+2 −1
Original line number Diff line number Diff line
@@ -31,7 +31,8 @@ func runNinja(ctx Context, config Config) { 
	defer ctx.EndTrace()



	fifo := filepath.Join(config.OutDir(), ".ninja_fifo")

	status.NinjaReader(ctx, ctx.Status.StartTool(), fifo)

	nr := status.NewNinjaReader(ctx, ctx.Status.StartTool(), fifo)

	defer nr.Close()



	executable := config.PrebuiltBuildTool("ninja")

	args := []string{

ui/build/soong.go

+2 −1
Original line number Diff line number Diff line
@@ -109,7 +109,8 @@ func runSoong(ctx Context, config Config) { 
		defer ctx.EndTrace()



		fifo := filepath.Join(config.OutDir(), ".ninja_fifo")

		status.NinjaReader(ctx, ctx.Status.StartTool(), fifo)

		nr := status.NewNinjaReader(ctx, ctx.Status.StartTool(), fifo)

		defer nr.Close()



		cmd := Command(ctx, config, "soong "+name,

			config.PrebuiltBuildTool("ninja"),

ui/status/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -28,6 +28,7 @@ bootstrap_go_package { 
    ],

    testSrcs: [

        "kati_test.go",

        "ninja_test.go",

        "status_test.go",

    ],

}

ui/status/ninja.go

+75 −19
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ import ( 
	"io"

	"os"

	"syscall"

	"time"



	"github.com/golang/protobuf/proto"
@@ -27,9 +28,9 @@ import ( 
	"android/soong/ui/status/ninja_frontend"

)



// NinjaReader reads the protobuf frontend format from ninja and translates it

// NewNinjaReader reads the protobuf frontend format from ninja and translates it

// into calls on the ToolStatus API.

func NinjaReader(ctx logger.Logger, status ToolStatus, fifo string) {

func NewNinjaReader(ctx logger.Logger, status ToolStatus, fifo string) *NinjaReader {

	os.Remove(fifo)



	err := syscall.Mkfifo(fifo, 0666)
@@ -37,14 +38,69 @@ func NinjaReader(ctx logger.Logger, status ToolStatus, fifo string) { 
		ctx.Fatalf("Failed to mkfifo(%q): %v", fifo, err)

	}



	go ninjaReader(status, fifo)

	n := &NinjaReader{

		status: status,

		fifo:   fifo,

		done:   make(chan bool),

		cancel: make(chan bool),

	}



func ninjaReader(status ToolStatus, fifo string) {

	f, err := os.Open(fifo)

	go n.run()



	return n

}



type NinjaReader struct {

	status ToolStatus

	fifo   string

	done   chan bool

	cancel chan bool

}



const NINJA_READER_CLOSE_TIMEOUT = 5 * time.Second



// Close waits for NinjaReader to finish reading from the fifo, or 5 seconds.

func (n *NinjaReader) Close() {

	// Signal the goroutine to stop if it is blocking opening the fifo.

	close(n.cancel)



	timeoutCh := time.After(NINJA_READER_CLOSE_TIMEOUT)



	select {

	case <-n.done:

		// Nothing

	case <-timeoutCh:

		n.status.Error(fmt.Sprintf("ninja fifo didn't finish after %s", NINJA_READER_CLOSE_TIMEOUT.String()))

	}



	return

}



func (n *NinjaReader) run() {

	defer close(n.done)



	// Opening the fifo can block forever if ninja never opens the write end, do it in a goroutine so this

	// method can exit on cancel.

	fileCh := make(chan *os.File)

	go func() {

		f, err := os.Open(n.fifo)

		if err != nil {

		status.Error(fmt.Sprintf("Failed to open fifo: %v", err))

			n.status.Error(fmt.Sprintf("Failed to open fifo: %v", err))

			close(fileCh)

			return

		}

		fileCh <- f

	}()



	var f *os.File



	select {

	case f = <-fileCh:

		// Nothing

	case <-n.cancel:

		return

	}



	defer f.Close()



	r := bufio.NewReader(f)
@@ -55,7 +111,7 @@ func ninjaReader(status ToolStatus, fifo string) { 
		size, err := readVarInt(r)

		if err != nil {

			if err != io.EOF {

				status.Error(fmt.Sprintf("Got error reading from ninja: %s", err))

				n.status.Error(fmt.Sprintf("Got error reading from ninja: %s", err))

			}

			return

		}
@@ -64,9 +120,9 @@ func ninjaReader(status ToolStatus, fifo string) { 
		_, err = io.ReadFull(r, buf)

		if err != nil {

			if err == io.EOF {

				status.Print(fmt.Sprintf("Missing message of size %d from ninja\n", size))

				n.status.Print(fmt.Sprintf("Missing message of size %d from ninja\n", size))

			} else {

				status.Error(fmt.Sprintf("Got error reading from ninja: %s", err))

				n.status.Error(fmt.Sprintf("Got error reading from ninja: %s", err))

			}

			return

		}
@@ -74,13 +130,13 @@ func ninjaReader(status ToolStatus, fifo string) { 
		msg := &ninja_frontend.Status{}

		err = proto.Unmarshal(buf, msg)

		if err != nil {

			status.Print(fmt.Sprintf("Error reading message from ninja: %v", err))

			n.status.Print(fmt.Sprintf("Error reading message from ninja: %v", err))

			continue

		}



		// Ignore msg.BuildStarted

		if msg.TotalEdges != nil {

			status.SetTotalActions(int(msg.TotalEdges.GetTotalEdges()))

			n.status.SetTotalActions(int(msg.TotalEdges.GetTotalEdges()))

		}

		if msg.EdgeStarted != nil {

			action := &Action{
@@ -88,7 +144,7 @@ func ninjaReader(status ToolStatus, fifo string) { 
				Outputs:     msg.EdgeStarted.Outputs,

				Command:     msg.EdgeStarted.GetCommand(),

			}

			status.StartAction(action)

			n.status.StartAction(action)

			running[msg.EdgeStarted.GetId()] = action

		}

		if msg.EdgeFinished != nil {
@@ -101,7 +157,7 @@ func ninjaReader(status ToolStatus, fifo string) { 
					err = fmt.Errorf("exited with code: %d", exitCode)

				}



				status.FinishAction(ActionResult{

				n.status.FinishAction(ActionResult{

					Action: started,

					Output: msg.EdgeFinished.GetOutput(),

					Error:  err,
@@ -112,17 +168,17 @@ func ninjaReader(status ToolStatus, fifo string) { 
			message := "ninja: " + msg.Message.GetMessage()

			switch msg.Message.GetLevel() {

			case ninja_frontend.Status_Message_INFO:

				status.Status(message)

				n.status.Status(message)

			case ninja_frontend.Status_Message_WARNING:

				status.Print("warning: " + message)

				n.status.Print("warning: " + message)

			case ninja_frontend.Status_Message_ERROR:

				status.Error(message)

				n.status.Error(message)

			default:

				status.Print(message)

				n.status.Print(message)

			}

		}

		if msg.BuildFinished != nil {

			status.Finish()

			n.status.Finish()

		}

	}

}

ui/status/ninja_test.go

0 → 100644
+45 −0
Original line number Diff line number Diff line 
// Copyright 2019 Google Inc. All rights reserved.

//

// Licensed 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 status



import (

	"io/ioutil"

	"os"

	"path/filepath"

	"testing"

	"time"



	"android/soong/ui/logger"

)



// Tests that closing the ninja reader when nothing has opened the other end of the fifo is fast.

func TestNinjaReader_Close(t *testing.T) {

	tempDir, err := ioutil.TempDir("", "ninja_test")

	if err != nil {

		t.Fatal(err)

	}

	defer os.RemoveAll(tempDir)



	stat := &Status{}

	nr := NewNinjaReader(logger.New(ioutil.Discard), stat.StartTool(), filepath.Join(tempDir, "fifo"))



	start := time.Now()



	nr.Close()



	if g, w := time.Since(start), NINJA_READER_CLOSE_TIMEOUT; g >= w {

		t.Errorf("nr.Close timed out, %s > %s", g, w)

	}

}