xref: /openbmc/hiomapd/test/tmpf.h (revision c3144042)
1 /*
2  * Mailbox Daemon Temporary File helpers
3  *
4  * Copyright 2017 IBM
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  */
19 
20 #ifndef MBOX_TEST_UTILS_H
21 #define MBOX_TEST_UTILS_H
22 
23 #include <linux/limits.h>
24 
25 struct tmpf {
26 	int fd;
27 	char path[PATH_MAX];
28 };
29 
30 /**
31  * Initialise a tmpf instance for use, creating a temporary file.
32  *
33  * @tmpf: A context to initialise with the provided template
34  * @template_str: A file basename in mkstemp(3) template form
35  *
36  * Returns 0 on success, or -1 on error with errno set appropriately
37  */
38 int tmpf_init(struct tmpf *tmpf, const char *template_str);
39 
40 /**
41  * Destroy a tmpf instance, closing the file descriptor and removing the
42  * temporary file.
43  */
44 void tmpf_destroy(struct tmpf *tmpf);
45 
46 #endif /* MBOX_TEST_UTILS_H */
47