plugins_manager.cpp 16 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 std::list<std::string> plugin_search_path()
64
{
65
  std::list<std::string> dirs;
66
	std::string obj_str ;
67
	const char *env_str = std::getenv("ALTA_PLUGIN_PATH");
68 69

	if(env_str == NULL) {
70
		obj_str = "";
71
	} else {
72
    obj_str = env_str;
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 98
  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);
      }
  }
99 100

  return dirs;
101 102
}

103 104 105
//! \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.
106 107
template<typename T>
static T open_library(const std::string& filename, const char* function)
108
{
109
  auto directories = plugin_search_path();
110

111
	for (auto&& directory: directories)
112
	{
113
    auto libname = directory + "/" + library_name(filename);
114

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

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

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

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

172 173
	std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << filename << std::endl;
	return NULL;
174 175
}

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

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

190 191
	// Parameters of the function object
	int nX, nY;
192
	params::input param_in   = params::UNKNOWN_INPUT;
193
	params::output param_out = params::UNKNOWN_OUTPUT;
194 195 196 197 198 199 200 201
	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;
202 203 204

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

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

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

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

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

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

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

239
//! Get an instance of the function selected based on the name <em>n</em>.
240
//! Return NULL if none exists.
241
function* plugins_manager::get_function(const arguments& args)
242
{
243 244 245 246 247 248 249
  #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
250 251 252 253
    #ifdef DEBUG
    std::cout << "<<DEBUG>> no function plugin specified, returning a rational function" << std::endl;
    #endif
    return new rational_function();
254 255 256 257 258 259 260 261 262 263
  }

  // 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 
264

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

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

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

276 277
	 //! For each args_vec element, create a function object and add ! it to the
	 //compound one.
278 279 280 281
    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
282 283

      #ifdef DEBUG
284 285 286
      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
287 288
      #endif
      
289
      arguments temp_args = arguments::create_arguments(n);
290

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

304
		  //! return the compound class 
305
		  func = compound;
306 307 308
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << " WE HAVE A COMPOUND " << std::endl;
      #endif
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
309 310 311 312 313 314 315 316 317 318 319 320
  }
  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();
321
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
322
    else
323
    {
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
324 325
      std::cerr << "<<ERROR>> no function provider found in file \"" << filename << "\"" << std::endl;
      return new rational_function() ;
326
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
327
  }
328

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

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
337 338 339 340 341 342 343 344 345 346
      // 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;
347

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
      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);
       }
      }

369 370 371 372 373
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " n = " << n << std::endl;
      #endif
       
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
374 375 376
      nonlinear_function* func_fres = dynamic_cast<nonlinear_function*>(get_function(arguments::create_arguments(n)));
      if(func_fres != NULL)
      {
377 378 379 380 381 382 383 384 385 386 387 388
        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;
        }

389 390 391
        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
392 393 394
      }
      else
      {
395 396
        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
397
      }
398
	 }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
399 400

   
401
/*
402 403 404 405 406 407 408
	 // 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
409
*/
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
410 411


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


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
432
        return ptr<function>(myFunc());
433 434 435 436 437 438 439 440 441
    }
    else
    {
        std::cerr << "<<ERROR>> no function provider found in file \"" << n << "\"" << std::endl;
        return NULL;
    }
}


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

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

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

491 492 493
void plugins_manager::check_compatibility( ptr<data>& d, 
                                           const ptr<function>& f,
                                           const arguments& args)
Laurent Belcour's avatar
Laurent Belcour committed
494
{
495 496
	if(d->input_parametrization() == params::UNKNOWN_INPUT &&
		f->input_parametrization() == params::UNKNOWN_INPUT)
Laurent Belcour's avatar
Laurent Belcour committed
497
	{
498
		std::cout << "<<WARNING>> both function and data objects have no parametrization" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
499 500 501
	}
	else
	{
502 503 504 505 506 507 508 509 510 511
		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());
		}
512
		else if(d->input_parametrization() != f->input_parametrization() && args.is_defined("change-param"))
513
		{
514
			std::cout << "<<INFO>> has to change the parametrization of the input data " << params::get_name(d->input_parametrization()) << std::endl;
515
      std::cout << "<<INFO>> to " << params::get_name(f->input_parametrization()) << std::endl;
516
			ptr<data_params> dd = ptr<data_params>(new data_params(d, f->input_parametrization()));
517
			d = dynamic_pointer_cast<data>(dd) ;
518 519 520 521 522
		}
		else
		{
			std::cout << "<<DEBUG>> no change was made to the parametrization" << std::endl;
		}
Laurent Belcour's avatar
Laurent Belcour committed
523 524 525 526
	}

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

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

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