annotate gcc/jit/jit-tempdir.h @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* Managing temporary directories and their content within libgccjit.so
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
kono
parents:
diff changeset
4
kono
parents:
diff changeset
5 This file is part of GCC.
kono
parents:
diff changeset
6
kono
parents:
diff changeset
7 GCC is free software; you can redistribute it and/or modify it
kono
parents:
diff changeset
8 under the terms of the GNU General Public License as published by
kono
parents:
diff changeset
9 the Free Software Foundation; either version 3, or (at your option)
kono
parents:
diff changeset
10 any later version.
kono
parents:
diff changeset
11
kono
parents:
diff changeset
12 GCC is distributed in the hope that it will be useful, but
kono
parents:
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
kono
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
kono
parents:
diff changeset
15 General Public License for more details.
kono
parents:
diff changeset
16
kono
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
18 along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
19 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
20
kono
parents:
diff changeset
21 #ifndef JIT_TEMPDIR_H
kono
parents:
diff changeset
22 #define JIT_TEMPDIR_H
kono
parents:
diff changeset
23
kono
parents:
diff changeset
24 #include "jit-logging.h"
kono
parents:
diff changeset
25
kono
parents:
diff changeset
26 namespace gcc {
kono
parents:
diff changeset
27
kono
parents:
diff changeset
28 namespace jit {
kono
parents:
diff changeset
29
kono
parents:
diff changeset
30 /* A class to keep track of the jit::playback::context's tempdir.
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 The tempdir has the following layout:
kono
parents:
diff changeset
33
kono
parents:
diff changeset
34 /tmp/libgccjit-XXXXXX/
kono
parents:
diff changeset
35 ./fake.c
kono
parents:
diff changeset
36 (doesn't exist, but the rest of the
kono
parents:
diff changeset
37 compiler needs a source code filename)
kono
parents:
diff changeset
38
kono
parents:
diff changeset
39 ./fake.s
kono
parents:
diff changeset
40 (created by toplev::main)
kono
parents:
diff changeset
41
kono
parents:
diff changeset
42 ./fake.so
kono
parents:
diff changeset
43 (created by playback::context::convert_to_dso).
kono
parents:
diff changeset
44
kono
parents:
diff changeset
45 It is normally deleted from the filesystem in the playback::context's
kono
parents:
diff changeset
46 dtor, unless GCC_JIT_BOOL_OPTION_KEEP_INTERMEDIATES was set. */
kono
parents:
diff changeset
47
kono
parents:
diff changeset
48 class tempdir : public log_user
kono
parents:
diff changeset
49 {
kono
parents:
diff changeset
50 public:
kono
parents:
diff changeset
51 tempdir (logger *logger, int keep_intermediates);
kono
parents:
diff changeset
52 ~tempdir ();
kono
parents:
diff changeset
53
kono
parents:
diff changeset
54 bool create ();
kono
parents:
diff changeset
55
kono
parents:
diff changeset
56 const char * get_path () const { return m_path_tempdir; }
kono
parents:
diff changeset
57 const char * get_path_c_file () const { return m_path_c_file; }
kono
parents:
diff changeset
58 const char * get_path_s_file () const { return m_path_s_file; }
kono
parents:
diff changeset
59 const char * get_path_so_file () const { return m_path_so_file; }
kono
parents:
diff changeset
60
kono
parents:
diff changeset
61 /* Add PATH to the vec of tempfiles that must be unlinked.
kono
parents:
diff changeset
62 Take ownership of the buffer PATH; it will be freed. */
kono
parents:
diff changeset
63 void add_temp_file (char *path) { m_tempfiles.safe_push (path); }
kono
parents:
diff changeset
64
kono
parents:
diff changeset
65 private:
kono
parents:
diff changeset
66 /* Was GCC_JIT_BOOL_OPTION_KEEP_INTERMEDIATES set? If so, keep the
kono
parents:
diff changeset
67 on-disk tempdir around after this wrapper object goes away. */
kono
parents:
diff changeset
68 int m_keep_intermediates;
kono
parents:
diff changeset
69
kono
parents:
diff changeset
70 /* Allocated using xmalloc (by xstrdup). */
kono
parents:
diff changeset
71 char *m_path_template;
kono
parents:
diff changeset
72
kono
parents:
diff changeset
73 /* This either aliases m_path_template, or is NULL. */
kono
parents:
diff changeset
74 char *m_path_tempdir;
kono
parents:
diff changeset
75
kono
parents:
diff changeset
76 /* The following are allocated using xmalloc. */
kono
parents:
diff changeset
77 char *m_path_c_file;
kono
parents:
diff changeset
78 char *m_path_s_file;
kono
parents:
diff changeset
79 char *m_path_so_file;
kono
parents:
diff changeset
80
kono
parents:
diff changeset
81 /* Other files within the tempdir to be cleaned up:
kono
parents:
diff changeset
82 - certain ahead-of-time compilation artifacts (.o and .exe files)
kono
parents:
diff changeset
83 - dumpfiles that were requested via gcc_jit_context_enable_dump. */
kono
parents:
diff changeset
84 auto_vec <char *> m_tempfiles;
kono
parents:
diff changeset
85 };
kono
parents:
diff changeset
86
kono
parents:
diff changeset
87 } // namespace gcc::jit
kono
parents:
diff changeset
88
kono
parents:
diff changeset
89 } // namespace gcc
kono
parents:
diff changeset
90
kono
parents:
diff changeset
91 #endif /* JIT_TEMPDIR_H */