pprof/internal/driver/tempfile.go

// Copyright 2014 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 driver

import (
	"fmt"
	"os"
	"path/filepath"
	"sync"
)

// newTempFilePath returns an unused path for output files.
func newTempFilePath(dir, prefix, suffix string) (string, error) {
	for index := 1; index < 10000; index++ {
		path := filepath.Join(dir, fmt.Sprintf("%s%03d%s", prefix, index, suffix))
		if _, err := os.Stat(path); err != nil {
			return path, nil
		}
	}
	// Give up
	return "", fmt.Errorf("could not create file of the form %s%03d%s", prefix, 1, suffix)
}

// newTempFile returns a new file with a random name for output files.
func newTempFile(dir, prefix, suffix string) (*os.File, error) {
	path, err := newTempFilePath(dir, prefix, suffix)
	if err != nil {
		return nil, err
	}
	return os.Create(path)
}

type VolatileFile struct {
	*os.File
}

func (file VolatileFile) Close() error {
	if err := file.File.Close(); err != nil {
		return err
	}
	if err := os.Remove(file.Name()); err != nil {
		return err
	}
	return nil
}

// DeleteOnClose deletes file on Close().
func DeleteOnClose(file *os.File) VolatileFile {
	return VolatileFile {
		File: file,
	}
}

var tempFiles []string
var tempFilesMu = sync.Mutex{}

// deferDeleteTempFile marks a file to be deleted by next call to Cleanup()
func deferDeleteTempFile(path string) {
	tempFilesMu.Lock()
	tempFiles = append(tempFiles, path)
	tempFilesMu.Unlock()
}

// cleanupTempFiles removes any temporary files selected for deferred cleaning.
func cleanupTempFiles() {
	tempFilesMu.Lock()
	for _, f := range tempFiles {
		os.Remove(f)
	}
	tempFiles = nil
	tempFilesMu.Unlock()
}