plugins_manager.cpp 16.1 KB
Newer Older
1 2 3
/* ALTA --- Analysis of Bidirectional Reflectance Distribution Functions

   Copyright (C) 2014, 2015 CNRS
4
   Copyright (C) 2013, 2014, 2015, 2016 Inria
5 6 7 8 9 10 11

   This file is part of ALTA.

   This Source Code Form is subject to the terms of the Mozilla Public
   License, v. 2.0.  If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.  */

12
#include "plugins_manager.h"
13 14
#include "rational_function.h"
#include "vertical_segment.h"
15

pacanows's avatar
pacanows committed
16
#ifdef _WIN32
17
    #include <windows.h>
18 19 20
#else
    #include <dlfcn.h>
#endif
21
#include <cstdlib>
22
#include <stdio.h>
23
#include <list>
24

25 26 27
//#define DEBUG


28 29
//! Add dynamic library extension (.so or .dll) to a dynamic object as well as
//! prepending 'lib' depending on the plateform.
30
static std::string library_name(const std::string name)
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
{
	std::string filename;

	const int n = name.length();
#if defined( _WIN32)
	if(name.substr(n-4, n) != std::string("dll")) {
		filename.append(name);
		filename.append(".dll");
	}
#elif defined(__APPLE__)
	if(name.substr(n-5, n) != std::string("dylib")) {
		filename.append("lib");
		filename.append(name);
		filename.append(".dylib");
	}
#else
	if(name.substr(n-2, n) != std::string("so")) {
		filename.append("lib");
		filename.append(name);
		filename.append(".so");
	}
#endif
	else {
		filename.append(name);
	}

	return filename;
}

60 61 62
// Return the plugin search path based on the 'ALTA_PLUGIN_PATH' environment
// variable.  Empty entries in that variable's value are taken to designate
// the plugin installation directory.
63
static void plugin_search_path(std::list<std::string>& dirs)
64 65
{
	std::string obj_str ;
66
	const char *env_str = std::getenv("ALTA_PLUGIN_PATH");
67 68

	if(env_str == NULL) {
69
		obj_str = "";
70
	} else {
71
    obj_str = env_str;
72 73
	}

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
  if (obj_str.empty())
      // Always add at least the system's plugin directory.
      dirs.push_back(ALTA_PLUGIN_DIRECTORY);
  else {
      for (auto start = 0, next = 0;
           start < obj_str.size();
           start = next + 1)
      {
          next = obj_str.find(':', start);
          if (next == std::string::npos)
              next = obj_str.size();

          // An empty entry denotes the system directory.
          auto entry = next == start
              ? ALTA_PLUGIN_DIRECTORY
              : obj_str.substr(start, next - start);

          dirs.push_back(entry);

          if (next == obj_str.size() - 1)
              // This is a trailing empty entry.
              dirs.push_back(ALTA_PLUGIN_DIRECTORY);
      }
  }
98 99
}

100 101 102
//! \brief Open a dynamic library file (.so or .dll) and extract the associated
//! provide function. The template argument is used to cast the library to a
//! specific type.
103 104
template<typename T>
static T open_library(const std::string& filename, const char* function)
105
{
106
	std::list<std::string> basename;
107
	plugin_search_path(basename);
108 109 110 111

	std::list<std::string>::iterator iter;
	for(iter = basename.begin(); iter != basename.end(); ++iter)
	{
112
	 std::string libname = *iter;
113
	 libname += "/" + library_name(filename);
114

115

pacanows's avatar
pacanows committed
116
#ifdef _WIN32
117
    HINSTANCE handle = LoadLibraryA(libname.c_str());
118 119 120 121 122 123
    if(handle != NULL)
    {
        T res = (T)GetProcAddress(handle, function);

        if(res == NULL)
        {
124 125 126 127
#ifdef DEBUG_CORE
			  std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << filename << std::endl;
#endif
			  continue;
128 129 130 131 132 133 134 135
        }
#ifdef DEBUG_CORE
        std::cout << "<<DEBUG>> will provide a " << function << " for library \"" << filename << "\"" << std::endl;
#endif
        return res;
    }
    else
    {
136
#ifdef DEBUG_CORE
137
        std::cerr << "<<ERROR>> unable to load the dynamic library file \"" << libname << "\"" << std::endl;
138
        std::cerr << "          cause: \"" << GetLastError() << "\"" << std::endl;
139 140
#endif
		 continue;
141
    }
142
#else
143
    void* handle = dlopen(libname.c_str(), RTLD_GLOBAL | RTLD_LAZY);
144

145
	 if(handle != NULL)
146 147 148
	 {
		 void (*res)();
		 *(void **)(&res) = dlsym(handle, function);
149 150 151

        if(dlerror() != NULL)
        {
152
#ifdef DEBUG_CORE
153
            std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << libname << std::endl;
154
#endif
155
            continue;
156 157
        }
#ifdef DEBUG_CORE
158
        std::cout << "<<DEBUG>> will provide a " << function << " for library \"" << libname << "\"" << std::endl;
159 160 161 162 163
#endif
        return (T)res;
    }
    else
    {
164
#ifdef DEBUG_CORE
165
        std::cerr << "<<ERROR>> unable to load the dynamic library file \"" << libname << "\"" << std::endl;
166
		  std::cerr << "          cause: \"" << dlerror() << "\"" << std::endl;
167
#endif
168
        continue;
169 170
    }
#endif
171
	}
172 173 174
   
	std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << filename << std::endl;
	return NULL;
175 176
}

177
//! \brief load a function from the ALTA input file.
178
function* plugins_manager::load_function(const std::string& filename)
179 180 181 182 183 184
{
	std::ifstream file;
	file.open(filename.c_str()) ;
	if(!file.is_open())
	{
		std::cerr << "<<ERROR>> unable to open file \"" << filename << "\"" << std::endl ;
185
		return NULL;
186 187
	}

188 189 190
	// Set the precision of the input
	file.precision(10);

191 192
	// Parameters of the function object
	int nX, nY;
193
	params::input param_in   = params::UNKNOWN_INPUT;
194
	params::output param_out = params::UNKNOWN_OUTPUT;
195 196 197 198 199 200 201 202
	arguments args;

	// Test for the first line of the file. Should be a ALTA FUNC HEADER
	std::string line ;
	std::getline(file, line) ;
	if(line != "#ALTA FUNC HEADER")
	{
		std::cerr << "<<ERROR>> this is not a function file" << std::endl;
203 204 205

    //RP: Returning NULL immediately now
    return NULL;
206 207 208 209
	}

	// Parse the header for the function command line and the dimension
	// of the function
210
	arguments header = arguments::parse_header(file);
211

212
	std::pair<int, int> dim = header.get_pair<int>("DIM");
213 214
	nX = dim.first;
	nY = dim.second;
215

216 217
	param_in = params::parse_input(header.get_string("PARAM_IN", "UNKNOWN_INPUT"));
	param_out = params::parse_output(header.get_string("PARAM_OUT", "UNKNOWN_OUTPUT"));
218
	args = arguments::create_arguments(header["CMD"]);
219 220 221 222 223

	// Create the function from the command line
	function* f = get_function(args);
	f->setDimX(nX);
	f->setDimY(nY);
224 225 226 227
  if(f->input_parametrization() == params::UNKNOWN_INPUT)
  {
    f->setParametrization(param_in);
  }
228
	f->setParametrization(param_out);
229 230

	// Load the function part from the file object
231 232 233 234
  if( f->load(file) )
  {
    return f;
  }
235

236 237
  std::cout << "<<ERROR>> COULD NOT LOAD THE BRDF from File " << filename << std::endl;
	 return NULL;
238 239
}

240
//! Get an instance of the function selected based on the name <em>n</em>.
241
//! Return NULL if none exists.
242
function* plugins_manager::get_function(const arguments& args)
243
{
244 245 246 247 248 249 250
  #ifdef DEBUG
  std::cout << __FILE__ << " " << __LINE__ << std::endl;
  std::cout << " INitial args = " << args << std::endl;
  #endif

  if(!args.is_defined("func"))
  {
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
251 252 253 254
    #ifdef DEBUG
    std::cout << "<<DEBUG>> no function plugin specified, returning a rational function" << std::endl;
    #endif
    return new rational_function();
255 256 257 258 259 260 261 262 263 264
  }

  // The function to be returned.
  function* func = NULL;

  if(args.is_vec("func")) //Checking if  the argument prodived with --func is of the form --func [ arg1, arg2, arg3]
  {
    #ifdef DEBUG
    std::cout << __FILE__ << " " << __LINE__ << " ARGUMENTS of --func are forming a VECTOR " << std::endl;
    #endif 
265

266
    std::vector<std::string> args_vec = args.get_vec("func");
Laurent Belcour's avatar
Laurent Belcour committed
267

268 269
    // Treating the case []
    if(args_vec.size() == 0)
270
    {
271 272
        return NULL;
    }
273

274
	 //! create a *compound* class to store multiple ! functions in it.
275
    compound_function* compound = new compound_function();
276

277 278
	 //! For each args_vec element, create a function object and add ! it to the
	 //compound one.
279 280 281 282
    for(unsigned int i=0; i<args_vec.size(); ++i)
    {
      std::string n("--func ");
      n.append(args_vec[i]);
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
283 284

      #ifdef DEBUG
285 286 287
      std::cout << __FILE__ << " " << __LINE__ << std::endl
                << " at i=" << i << " n=" << n << std::endl;
      std::cout << "<<DEBUG>> load function with args: " << n << std::endl;
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
288 289
      #endif
      
290
      arguments temp_args = arguments::create_arguments(n);
291

292 293
      //Recursive call
      function* f = get_function(temp_args);
294 295
      nonlinear_function *nl_f = dynamic_cast<nonlinear_function*>(f);
      if(nl_f == NULL)
296 297 298 299 300
      {
          std::cerr << "<<ERROR>> only non-linear functions are compatible with a compound" << std::endl;
      }
      else
      {
301
          compound->push_back(ptr<nonlinear_function>(nl_f), temp_args);
302 303
      }
    }
304

305
		  //! return the compound class 
306
		  func = compound;
307 308 309
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << " WE HAVE A COMPOUND " << std::endl;
      #endif
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
310 311 312 313 314 315 316 317 318 319 320 321
  }
  else //Here we check if the argument provided with --func is file describing a function
  {
    const std::string filename = args["func"];
    FunctionPrototype myFunction = open_library<FunctionPrototype>(filename, "provide_function");
    if(myFunction != NULL)
    {
      #ifdef DEBUG
      std::cout << "<<DEBUG>> using function provider in file \"" << filename << "\"" << std::endl;
      #endif
      
      func =  myFunction();
322
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
323
    else
324
    {
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
325 326
      std::cerr << "<<ERROR>> no function provider found in file \"" << filename << "\"" << std::endl;
      return new rational_function() ;
327
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
328
  }
329

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
330 331 332
  // Treat the case of the Fresnel
  if(args.is_defined("fresnel"))
  {
333 334 335 336 337
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " INSIDE fresnel args = " << args << std::endl;
      #endif

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
338 339 340 341 342 343 344 345 346 347
      // Cast into a non linear function, only those are permitted to use
      // a Fresnel term.
      nonlinear_function* nl_func = dynamic_cast<nonlinear_function*>(func);
      if(nl_func == NULL)
      {
       std::cerr << "<<ERROR>> only non-linear function are permitted to use Fresnel" << std::endl;
       return func;
      }

      std::cout << "<<DEBUG>> multiplying by a Fresnel term" << std::endl;
348

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
      std::string n("--func ");
      if(args.is_vec("fresnel"))
      {
       std::string temp = args["fresnel"];
       n.append(temp.substr(1, temp.size()-2));
      }
      else
      {
       std::string fname = args["fresnel"];
       if(fname.empty()) // Nothing to do except print error, no plugin defined
       {
      	 std::cerr << "<<ERROR>> Fresnel plugin not defined" << std::endl;
      	 std::cerr << "<<ERROR>> using --fresnel alone is not permitted" << std::endl;
      	 return func;
       }
       else // Case where the fresnel parameters is only the plugin filename
       {
      	 n.append(fname);
       }
      }

370 371 372 373 374
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " n = " << n << std::endl;
      #endif
       
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
375 376 377
      nonlinear_function* func_fres = dynamic_cast<nonlinear_function*>(get_function(arguments::create_arguments(n)));
      if(func_fres != NULL)
      {
378 379 380 381 382 383 384 385 386 387 388 389
        bool const fresnel_is_fixed = (args.is_defined("fixed-fresnel")) ? (true) : (false);
        bool const lobe_is_fixed    = (args.is_defined("fixed-lobe")) ? (true) : (false);
       
        if( fresnel_is_fixed )
        {
          std::cout << "<<DEBUG>> The Fresnel term is fixed" << std::endl;
        }
        if( lobe_is_fixed )
        {
          std::cout << "<<DEBUG>> The lobe is fixed" << std::endl;
        }

390 391 392
        return new product_function(ptr<nonlinear_function>(nl_func),
                                    ptr<nonlinear_function>(func_fres),
                                    lobe_is_fixed, fresnel_is_fixed);
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
393 394 395
      }
      else
      {
396 397
        std::cerr << "<<ERROR>> the right part of the product is not a nonlinear function. Will use only the left part." << std::endl;
        return func;
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
398
      }
399
	 }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
400 401

   
402
/*
403 404 405 406 407 408 409
	 // Correction of the data by 1/cosine(theta_L)
	 if(args.is_defined("data-correct-cosine"))
	 {
		 nonlinear_function* cosine = new cosine_function();
		 func = new product_function(cosine, dynamic_cast<nonlinear_function*>(func));
	 }
	 // End of correction
410
*/
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
411 412


413
    return func;
414
}
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432


ptr<function> plugins_manager::get_function(const std::string& n)
{
    if(n.empty())
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> no function plugin specified, returning nothing" << std::endl;
#endif
        return NULL;
    }

	 FunctionPrototype myFunc = open_library<FunctionPrototype>(n, "provide_function");
    if(myFunc != NULL)
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> using function provider in file \"" << n << "\"" << std::endl;
#endif
433
        return ptr<function>(myFunc());
434 435 436 437 438 439 440 441 442
    }
    else
    {
        std::cerr << "<<ERROR>> no function provider found in file \"" << n << "\"" << std::endl;
        return NULL;
    }
}


443
ptr<data> plugins_manager::get_data(const std::string& n, const arguments& args)
444
{
445
    if(n.empty() || n == "vertical_segment")
446
    {
447
#ifdef DEBUG
448
        std::cout << "<<DEBUG>> no data plugin specified, returning a vertical_segment loader" << std::endl;
449
#endif
450
        return ptr<data>(new vertical_segment());
451 452
    }

453
	 DataPrototype myData = open_library<DataPrototype>(n, "provide_data");
454 455
    if(myData != NULL)
    {
456
#ifdef DEBUG
457
        std::cout << "<<DEBUG>> using data provider in file \"" << n << "\"" << std::endl;
458
#endif
459
        return ptr<data>(myData(args));
460 461 462 463
    }
    else
    {
        std::cerr << "<<ERROR>> no data provider found in file \"" << n << "\"" << std::endl;
464
        return ptr<data>(new vertical_segment()) ;
465
    }
466
}
467
ptr<fitter> plugins_manager::get_fitter(const std::string& n)
468
{
Laurent Belcour's avatar
Laurent Belcour committed
469 470 471 472 473
    if(n.empty())
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> no fitter plugin specified, returning null" << std::endl;
#endif
474
        return NULL;
Laurent Belcour's avatar
Laurent Belcour committed
475 476
    }

477
    FitterPrototype myFitter = open_library<FitterPrototype>(n, "provide_fitter");
Laurent Belcour's avatar
Laurent Belcour committed
478 479 480
    if(myFitter != NULL)
    {
#ifdef DEBUG
481
        std::cout << "<<DEBUG>> using fitter provider in file \"" << n << "\"" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
482
#endif
483
        return ptr<fitter>(myFitter());
Laurent Belcour's avatar
Laurent Belcour committed
484 485 486
    }
    else
    {
487
        std::cerr << "<<ERROR>> no fitter provider found in file \"" << n << "\"" << std::endl;
488
        return NULL ;
Laurent Belcour's avatar
Laurent Belcour committed
489
    }
490
}
491

492 493 494
void plugins_manager::check_compatibility( ptr<data>& d, 
                                           const ptr<function>& f,
                                           const arguments& args)
Laurent Belcour's avatar
Laurent Belcour committed
495
{
496 497
	if(d->input_parametrization() == params::UNKNOWN_INPUT &&
		f->input_parametrization() == params::UNKNOWN_INPUT)
Laurent Belcour's avatar
Laurent Belcour committed
498
	{
499
		std::cout << "<<WARNING>> both function and data objects have no parametrization" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
500 501 502
	}
	else
	{
503 504 505 506 507 508 509 510 511 512
		if(d->input_parametrization() == params::UNKNOWN_INPUT)
		{
			std::cout << "<<WARNING>> unknown parametrization for data" << std::endl;
		}

		if(f->input_parametrization() == params::UNKNOWN_INPUT)
		{
			std::cout << "<<DEBUG>> function will take the parametrization of the data" << std::endl;
			f->setParametrization(d->input_parametrization());
		}
513
		else if(d->input_parametrization() != f->input_parametrization() && args.is_defined("change-param"))
514
		{
515
			std::cout << "<<INFO>> has to change the parametrization of the input data " << params::get_name(d->input_parametrization()) << std::endl;
516
      std::cout << "<<INFO>> to " << params::get_name(f->input_parametrization()) << std::endl;
517
			ptr<data_params> dd = ptr<data_params>(new data_params(d, f->input_parametrization()));
518
			d = dynamic_pointer_cast<data>(dd) ;
519 520 521 522 523
		}
		else
		{
			std::cout << "<<DEBUG>> no change was made to the parametrization" << std::endl;
		}
Laurent Belcour's avatar
Laurent Belcour committed
524 525 526 527
	}

	if(f->dimY() != d->dimY())
	{
528
    f->setDimY(d->dimY());
Laurent Belcour's avatar
Laurent Belcour committed
529 530 531 532 533 534 535 536 537 538 539
	}

	/*
	// Check is the data has to be clusterized
	if(args.is_defined("cluster-dim"))
	{
	clustering* cluster = new clustering(d, args);
	d = cluster;
	}
	*/
}
540

541
// \todo implement the Darwin (MACOS) version.
542 543
// \todo : Why not move these functions to common.h ?
#ifdef _WIN32
544
#include <windows.h>
545
size_t plugins_manager::get_system_memory()
546 547 548 549 550 551
{
	MEMORYSTATUSEX status;
	status.dwLength = sizeof(status);
	GlobalMemoryStatusEx(&status);
	return status.ullTotalPhys;
}
552 553 554 555 556
#elif defined(__APPLE__)
#include <unistd.h>
#include <sys/types.h>
#include <sys/param.h>
#include <sys/sysctl.h>
557 558
size_t plugins_manager::get_system_memory()
{
559 560 561 562 563 564 565 566 567
  int mib[2];
  mib[0] = CTL_HW;
  mib[1] = HW_MEMSIZE;    
  int64_t size = 0;   
	size_t len = sizeof( size );
  if ( sysctl( mib, 2, &size, &len, NULL, 0 ) == 0 )
    return (size_t)size;
  
  return 0L;
568
}
569 570
#else
#include <unistd.h>
571
size_t plugins_manager::get_system_memory()
572 573 574 575 576 577
{
	long pages = sysconf(_SC_PHYS_PAGES);
	long page_size = sysconf(_SC_PAGE_SIZE);
	return pages * page_size;
}
#endif