50 =
"FOAM_CODE_TEMPLATES";
53 =
"codeTemplates/dynamicCode";
56 =
"LIB = $(PWD)/../platforms/$(WM_OPTIONS)/lib";
73 <<
"This code should not be executed by someone"
74 <<
" with administrator rights for security reasons." <<
nl
75 <<
"It generates a shared library which is loaded using dlopen"
83 <<
"Loading shared libraries using case-supplied code may have"
84 <<
" been disabled" <<
nl
85 <<
"by default for security reasons." <<
nl
86 <<
"If you trust the code, you may enable this by adding"
88 <<
" allowSystemOperations 1" <<
nl <<
nl
89 <<
"to the InfoSwitches setting in the system controlDict." <<
nl
90 <<
"The system controlDict is any of" <<
nl <<
nl
92 <<
" ~/.OpenFOAM/controlDict" <<
nl
93 <<
" $WM_PROJECT_DIR/etc/controlDict" <<
nl <<
endl
111 <<
"Failed opening for reading " << is.
name()
118 <<
"Failed writing " <<
os.
name()
149 for (
const fileName& templateName : templateNames)
152 if (!templateDir.empty() &&
isDir(templateDir))
154 file = templateDir/templateName;
164 file =
findEtcFile(codeTemplateDirName/templateName);
169 badFiles.
append(templateName);
174 resolvedFiles.
append(file);
184 const auto fnd = filterVars_.cfind(
"SHA1sum");
191 os <<
"/* dynamicCode:\n * SHA1 = ";
200 if (compileFiles_.empty())
205 const fileName dstFile(this->codePath()/
"Make/files");
215 <<
"Failed writing " << dstFile
219 writeCommentSHA1(
os);
222 for (
const fileName& file : compileFiles_)
229 <<
"/lib" << codeName_.c_str() <<
nl;
238 if (compileFiles_.empty() || makeOptions_.empty())
243 const fileName dstFile(this->codePath()/
"Make/options");
253 <<
"Failed writing " << dstFile
257 writeCommentSHA1(
os);
293 codeRoot_(
argList::envGlobalPath()/topDirName),
294 libSubDir_(stringOps::expand(
"platforms/${WM_OPTIONS}/lib")),
296 codeDirName_(codeDirName)
298 if (codeDirName_.empty())
300 codeDirName_ = codeName_;
311 return topDirName/codeDirName_;
329 compileFiles_.clear();
331 createFiles_.clear();
333 filterVars_.set(
"typeName", codeName_);
334 filterVars_.set(
"SHA1sum",
SHA1Digest().str());
349 setFilterContext(context);
355 compileFiles_.append(
name);
361 copyFiles_.append(
name);
368 const string& contents
380 filterVars_.set(
"localCode", context.
localCode());
381 filterVars_.set(
"code", context.
code());
382 filterVars_.set(
"codeInclude", context.
include());
383 filterVars_.set(
"SHA1sum", context.
sha1().
str());
390 const std::string& value
393 filterVars_.set(key, value);
399 makeOptions_ = content;
408 <<
"Creating new library in " << this->libRelPath() <<
endl;
411 const label nFiles = compileFiles_.size() + copyFiles_.size();
417 resolveTemplates(compileFiles_, resolvedFiles, badFiles);
418 resolveTemplates(copyFiles_, resolvedFiles, badFiles);
420 if (!badFiles.
empty())
423 <<
"Could not find code template(s): "
425 <<
"Under the $" << codeTemplateEnvName
426 <<
" directory or via the <etc>/"
427 << codeTemplateDirName <<
" expansion"
434 const fileName outputDir = this->codePath();
440 for (
const fileName& srcFile : resolvedFiles)
449 <<
"Failed opening " << srcFile
458 <<
"Failed writing " << dstFile
463 copyAndFilter(is,
os, filterVars_);
478 <<
"Failed writing " << dstFile
489 writeDigest(filterVars_[
"SHA1sum"]);
497 stringList cmd({
"wmake",
"-s",
"libso", this->codePath()});
506 os <<
"Invoking wmake libso " << this->codePath().c_str() <<
endl;
532 return upToDate(context.
sha1());
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
bool upToDate() const
Access to the up-to-date flag.
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
void append(const T &val)
Copy append an element to the end of this list.
A HashTable similar to std::unordered_map.
Input from file stream, using an ISstream.
bool good() const noexcept
True if next operation might succeed.
Generic input stream using a standard (STL) stream.
virtual const fileName & name() const
Return the name of the stream.
ISstream & getLine(std::string &str, char delim='\n')
Raw, low-level getline (until delimiter) into a string.
virtual Ostream & writeQuoted(const std::string &str, const bool quoted=true)
Write std::string surrounded by quotes.
Output to file stream, using an OSstream.
virtual const fileName & name() const
Read/write access to the name of the stream.
Generic output stream using a standard (STL) stream.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Ostream & write(Ostream &os, const bool prefixed=false) const
Write (40-byte) text representation, optionally with '_' prefix.
std::string str(const bool prefixed=false) const
The digest (40-byte) text representation, optionally with '_' prefix.
A 2-tuple for storing two objects of dissimilar types. The container is similar in purpose to std::pa...
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
bool empty() const noexcept
True if the UList is empty (ie, size() is zero)
Extract command arguments and options from the supplied argc and argv parameters.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
static word fullname(word libName)
Library fullname, prefix with 'lib', suffix with '.so'.
Encapsulation of dynamic code dictionaries.
const string & code() const noexcept
The code.
const string & include() const noexcept
The code includes.
const SHA1 & sha1() const noexcept
The SHA1 calculated from options, libs, include, code, etc.
const string & localCode() const noexcept
The local (file-scope) code.
Tools for handling dynamic code compilation.
static int allowSystemOperations
Flag if system operations are allowed.
static void copyAndFilter(ISstream &, OSstream &, const HashTable< string > &mapping)
Copy lines while expanding variables.
bool copyOrCreateFiles(const bool verbose=false) const
Copy/create files prior to compilation.
void addCopyFile(const fileName &name)
Add a file template name, which will be found and filtered.
static const char *const targetLibDir
Directory for library targets for Make/files.
fileName libRelPath() const
Library path for specified code name relative to <case>
void addCreateFile(const fileName &name, const string &contents)
Add a file to create with its contents. Will not be filtered.
static bool resolveTemplates(const UList< fileName > &templateNames, DynamicList< fileName > &resolvedFiles, DynamicList< fileName > &badFiles)
Resolve code-templates via the codeTemplateEnvName.
static const word codeTemplateEnvName
Name of the code template environment variable.
static const char *const topDirName
Top-level directory name for copy/compiling.
void setFilterVariable(const word &key, const std::string &value)
Define a filter variable.
void setFilterContext(const dynamicCodeContext &)
Define filter variables for code, codeInclude, SHA1sum.
static void checkSecurity(const char *title, const dictionary &)
Check security for creating dynamic code.
bool createMakeFiles() const
Copy/create Make/files prior to compilation.
bool writeDigest(const SHA1Digest &) const
Write digest to Make/SHA1Digest.
fileName codeRelPath() const
Path for specified code name relative to <case>
void addCompileFile(const fileName &name)
Add a file template name, which will be found and filtered.
void clear()
Clear files and variables.
fileName libPath() const
Library path for specified code name.
static const fileName codeTemplateDirName
Name of the code template sub-directory.
bool createMakeOptions() const
Copy/create Make/options prior to compilation.
bool wmakeLibso() const
Compile a libso.
bool writeCommentSHA1(Ostream &) const
Write SHA1 value as C-comment.
void setMakeOptions(const std::string &content)
Define contents for Make/options.
void reset()
Reset to defaults.
A class for handling file names.
static std::string path(const std::string &str)
Return directory path name (part before last /)
static std::string name(const std::string &str)
Return basename (part beyond last /), including its extension.
A class for handling words, derived from Foam::string.
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Functions to search 'etc' directories for configuration files etc.
OBJstream os(runTime.globalPath()/outputName)
int infoSwitch(const char *name, const int deflt=0)
Lookup info switch or add default value.
void inplaceExpand(std::string &s, const HashTable< string > &mapping, const char sigil='$')
string expand(const std::string &s, const HashTable< string > &mapping, const char sigil='$')
string getEnv(const std::string &envName)
Get environment value for given envName.
bool exists(const fileName &name, const bool checkGzip=true, const bool followLink=true)
Does the name exist (as DIRECTORY or FILE) in the file system?
int system(const std::string &command, const bool bg=false)
Execute the specified command via the shell.
bool mkDir(const fileName &pathName, mode_t mode=0777)
Make a directory and return an error if it could not be created.
bool isAdministrator()
Is the current user the administrator (root)
messageStream Info
Information stream (stdout output on master, null elsewhere)
fileName findEtcFile(const fileName &name, const bool mandatory=false, unsigned short location=0777)
Search for a single FILE within the etc directories.
Ostream & endl(Ostream &os)
Add newline and flush stream.
OSstream Serr
OSstream wrapped stderr (std::cerr)
int infoDetailLevel
Global for selective suppression of Info output.
bool isFile(const fileName &name, const bool checkGzip=true, const bool followLink=true)
Does the name exist as a FILE in the file system?
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
errorManipArg< error, int > exit(error &err, const int errNo=1)
bool isDir(const fileName &name, const bool followLink=true)
Does the name exist as a DIRECTORY in the file system?
constexpr char nl
The newline '\n' character (0x0a)