Add 'default-bvh-flag' command line option #599

karjonas · 2018-10-23T11:31:58Z

No description provided.

tribal-tec

A test would be nice :) Showing that less memory is actually used.

tribal-tec · 2018-10-23T11:34:42Z

brayns/common/types.h

+
+enum class BVHType
+{
+    dynamic,


that's very ospray centric. what is 'none' even? Shouldn't it be a bitmask also? dynamic + compact sounds reasonable to me. If ospray can't do that, we shouldn't limit it here. 'Static' is missing also to me.

Since optimizations for a particular metric typically go against others, I think it's fair to have a single label to provide a hint about the expected usage.

tribal-tec · 2018-10-23T11:35:54Z

engines/ospray/OSPRayModel.cpp

@@ -510,6 +510,29 @@ bool OSPRayModel::_commitTransferFunction()
    return true;
 }

+void OSPRayModel::_commitBVHType()


ospCommit(_model) is missing then, otherwise the function should be renamed.

karjonas · 2018-10-23T14:53:04Z

How do I query the memory usage of the BVH?

karjonas · 2018-10-23T15:25:47Z

I think checking the ram usage is a bit hard so I added a simpler unit test.

hernando · 2018-10-24T08:08:05Z

brayns/common/utils/Utils.h

+}
+
+template <typename T>
+inline bool enumHas(const T eA, const T eB)


template<typename T> bool isBitSet(typename std::underlying_type<T>::type mask, const T bit)

hernando · 2018-10-24T08:38:35Z

brayns/common/utils/Utils.h

@@ -34,4 +36,18 @@ inline auto lowerCase(std::string str)
    std::transform(str.begin(), str.end(), str.begin(), ::tolower);
    return str;
 }
+
+template <typename T>
+inline T enumSet(const T eA, const T eB)


Suggested change

inline T enumSet(const T eA, const T eB)

template <typename T>

inline typename std::underlying_type<T>::type setBit(const std::underlying_type<T>::type mask, const T bit)

{

return mask | static_cast<typename std::underlying_type<T>::type>(bit);

}

You should return the underlying type, because semantically the output value is not the enum anymore.
But even worse, imagine you have this code

enum class A : int { a = 1, b = 2 }; int f(const A a) { switch(a) { case A::a: return int(a); case A::b: return int(a); } }

That code if perfect, but if you call f with something A(17), the function return value will be undefined.

hernando · 2018-10-24T08:41:49Z

brayns/parameters/GeometryParameters.cpp

+        //
+        (PARAM_DEFAULT_BVH_FLAG.c_str(),
+         po::value<std::vector<std::string>>()->multitoken(),
+         "Default bvh type [static|dynamic|compact|robust]");


It's not clear that you can have multiple flags and what is the token separator.

hernando · 2018-10-24T08:44:17Z

brayns/parameters/GeometryParameters.h

@@ -234,6 +234,7 @@ class GeometryParameters : public AbstractParameters
        return _morphologyUseSDFGeometries;
    }

+    BVHType getDefaultBVHType() const { return _defaultBVHType; }


int getDefaultBVHModes or getDefaultBVHTypeMask

hernando · 2018-10-24T08:44:57Z

engines/ospray/OSPRayModel.cpp

+
+    ospSet1i(_model, "dynamicMode", dynamicMode ? 1 : 0);
+    ospSet1i(_model, "compactMode", compactMode ? 1 : 0);
+    ospSet1i(_model, "robustMode", robustMode ? 1 : 0);


Suggested change

ospSet1i(_model, "robustMode", robustMode ? 1 : 0);

ospSet1i(_model, "robustMode", isBitSet(_bvhType, BVHTtype::dynamic));

hernando · 2018-10-24T08:50:20Z

brayns/common/scene/Model.h

@@ -97,9 +97,12 @@ class ModelParams : public ModelInstance
    const std::string& getName() const { return _name; }
    void setPath(const std::string& path) { _updateValue(_path, path); }
    const std::string& getPath() const { return _path; }
+    void setBVHType(BVHType bvhType) { _updateValue(_bvhType, bvhType); }
+    BVHType getBVHType() const { return _bvhType; }


It would be better if this parameter goes into the ModelDescriptor property map because then you can set it from the client. I'm not totally sure about the jsonrpc part, maybe @rolandjitsu can comment on this.

If you add it to the property map it would be rendered without any effort on my side (because it's generated from schema). Otherwise I'd need to add it myself.

But then you have to make sure that when the bvh property on the property map is set, you do your stuff (set the bvh type).

Also, I'm not sure how enums are handled currently for the property map props (if they are).

In fact it's not an enum, it's a bit mask. From the command line I think it's set as a space separated list of strings. I'd guess you don't have any code for rendering such a thing.

Nope, we don't handle bit masks.

For multiple selection we'd need some additional info from schema (instead of {type: 'string', enum: ['bla', ...]} has to be {type: 'array', items: {type: 'string', enum: ['bla', ...]}).

And then I'd need to add support for multiple selection.

If this is single selection, then we just need string enums instead of bitmask.

@tribal-tec requested it to be a multiple selection, but not all combinations are allowed... Another option is splitting this into multiple properties:

BVH update hint: static|dynamic

compact BVH: bool

robust BVH: bool
What do you think @karjonas ?

This should be easy to render and we only need to extend the schema to support single selection for a set of values.

As discussed offline, let's keep it as it is for the moment and open this can of worms later.

Use set instead of bitflags Remove bvh flags from model params

hernando · 2018-10-24T11:40:41Z

brayns/common/scene/Model.h

+    {
+        _bvhFlags = std::move(bvhFlags);
+    }
+    std::set<BVHFlag> getBVHFlags() const { return _bvhFlags; }


const std::set<BVHFlag>&

hernando · 2018-10-24T11:42:13Z

brayns/parameters/GeometryParameters.cpp

+        (PARAM_DEFAULT_BVH_FLAG.c_str(),
+         po::value<std::vector<std::string>>()->multitoken(),
+         "Sets one or more property flags to be used by default when creating "
+         "a bvh [dynamic|compact|robust]");


BVH
Same as before, it's not clear that this is a list? Or does boost program_options take care of indicating it?

I don't know how to explain it without a wall of text.

"Set a default flag to apply to BVH creation, one of [dynamic|compact|robust], may appear multiple times."

I'm not sure whether --default-bvh-flag "dynamic robust" is also accepted though.

Then, the message is not totally accurate, but at least it doesn't miss the possibility of setting multiple flags.

hernando · 2018-10-24T11:42:32Z

brayns/parameters/GeometryParameters.cpp

+            if (kv != BVH_TYPES.end())
+                _defaultBVHFlags.insert(kv->second);
+            else
+                throw std::runtime_error("Invalid bvh type '" + bvh + "'.");


type -> flag

hernando · 2018-10-24T11:43:50Z

engines/ospray/OSPRayModel.cpp

+    const bool compactMode = _bvhFlags.count(BVHFlag::compact);
+    const bool robustMode = _bvhFlags.count(BVHFlag::robust);
+
+    ospSet1i(_model, "dynamicMode", dynamicMode ? 1 : 0);


Suggested change

ospSet1i(_model, "dynamicMode", dynamicMode ? 1 : 0);

ospSet1i(_model, "dynamicMode", _bvhFlags.count(BVHFlag::dynamic));

hernando · 2018-10-24T11:44:39Z

tests/brayns.cpp

+    const char* app = testSuite.argv[0];
+    const char* argv[] = {
+        app,       "demo", "--default-bvh-flag", "robust", "--default-bvh-flag",
+        "compact",


I would have never guessed this is how you provide multiple flags through the command line...

Add 'default-bvh' command line flag

e1a0a94

karjonas requested a review from tribal-tec October 23, 2018 11:31

tribal-tec reviewed Oct 23, 2018

View reviewed changes

PR Fixes

f8584a2

karjonas requested a review from hernando October 24, 2018 07:30

hernando reviewed Oct 24, 2018

View reviewed changes

karjonas force-pushed the bvh_flag branch 3 times, most recently from d36fbd5 to e12851b Compare October 24, 2018 10:24

PR fixes

21130c9

Use set instead of bitflags Remove bvh flags from model params

karjonas force-pushed the bvh_flag branch from e12851b to 21130c9 Compare October 24, 2018 10:25

karjonas changed the title ~~Add 'default-bvh' command line flag~~ Add 'default-bvh-flag' command line option Oct 24, 2018

hernando reviewed Oct 24, 2018

View reviewed changes

Jonas Karlsson added 2 commits October 24, 2018 13:56

PR fixes

a950882

PR fixes

26d5f67

hernando approved these changes Oct 24, 2018

View reviewed changes

karjonas merged commit 9cc4564 into BlueBrain:master Oct 24, 2018

karjonas deleted the bvh_flag branch October 24, 2018 12:09

tribal-tec added the feature label Feb 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'default-bvh-flag' command line option #599

Add 'default-bvh-flag' command line option #599

karjonas commented Oct 23, 2018

tribal-tec left a comment

tribal-tec Oct 23, 2018

hernando Oct 23, 2018

tribal-tec Oct 23, 2018

karjonas commented Oct 23, 2018

karjonas commented Oct 23, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

rolandjitsu Oct 24, 2018 •

edited

Loading

hernando Oct 24, 2018

rolandjitsu Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

karjonas Oct 24, 2018

hernando Oct 24, 2018

karjonas Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

hernando Oct 24, 2018

	ospSet1i(_model, "robustMode", robustMode ? 1 : 0);
	ospSet1i(_model, "robustMode", isBitSet(_bvhType, BVHTtype::dynamic));

	ospSet1i(_model, "dynamicMode", dynamicMode ? 1 : 0);
	ospSet1i(_model, "dynamicMode", _bvhFlags.count(BVHFlag::dynamic));

Add 'default-bvh-flag' command line option #599

Add 'default-bvh-flag' command line option #599

Conversation

karjonas commented Oct 23, 2018

tribal-tec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karjonas commented Oct 23, 2018

karjonas commented Oct 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolandjitsu Oct 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolandjitsu Oct 24, 2018 •

edited

Loading