Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Zeek Table<->Brokerstore: cleanup, documentation, small fixes

Browse source 
This commit adds script/c++ documentation and fixes a few loose ends.
It also adds tests for corner cases and massively improves error
messages.

This also actually introduces type-compatibility checking and introduces
a new attribute that lets a user override this if they really know what
they are doing. I am not quite sure if we should really let that stay in
- but it can be very convenient to have this functionality.

One test is continuing to fail - the expiry test is very flaky. This is,
I think, caused by delays of the broker store forwarding. I am unsure if
we can actually do anything about that.
This commit is contained in:
Johanna Amann 2020-07-10 16:58:34 -07:00
parent 67917b83aa
commit 2b2a40f49c
26 changed files with 271 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

47
src/Attr.cc
View file

@ -8,6 +8,7 @@
#include "Val.h"
#include "IntrusivePtr.h"
#include "threading/SerialTypes.h"
#include "input/Manager.h"
namespace zeek::detail {
@ -19,8 +20,8 @@ const char* attr_name(AttrTag t)
"&read_expire", "&write_expire", "&create_expire",
"&raw_output", "&priority",
"&group", "&log", "&error_handler", "&type_column",
"(&tracked)", "&on_change", "&broker_store", "&backend",
"&deprecated",
"(&tracked)", "&on_change", "&broker_store",
"&broker_allow_complex_type", "&backend", "&deprecated",
};
return attr_names[int(t)];
@ -450,6 +451,10 @@ void Attributes::CheckAttr(Attr* a)
{
Error("&broker_store and &read_expire cannot be used simultaneously");
}
if ( Find(ATTR_BACKEND) )
{
Error("&broker_store and &backend cannot be used simultaneously");
}
}
// fallthrough
case ATTR_EXPIRE_WRITE:
@ -535,6 +540,10 @@ void Attributes::CheckAttr(Attr* a)
{
Error("&broker_store and &expire_func cannot be used simultaneously");
}
if ( Find(ATTR_BACKEND ) )
{
Error("&backend and &expire_func cannot be used simultaneously");
}
}
break;
@ -607,7 +616,7 @@ void Attributes::CheckAttr(Attr* a)
{
if ( ! global_var || type->Tag() != TYPE_TABLE )
{
Error("&broker_store only applicable to global sets/tables");
Error("&backend only applicable to global sets/tables");
break;
}
@ -615,7 +624,7 @@ void Attributes::CheckAttr(Attr* a)
// are here. We will do that later - before actually attaching to a broker store
if ( a->GetExpr()->GetType()->Tag() != TYPE_ENUM )
{
Error("&broker_store must take an enum argument");
Error("&backend must take an enum argument");
break;
}
@ -625,6 +634,14 @@ void Attributes::CheckAttr(Attr* a)
Error("&backend only supports one-element set/table indexes");
}
// Only support atomic types for the moment.
if ( ! type->AsTableType()->IsSet() &&
! input::Manager::IsCompatibleType(type->AsTableType()->Yield().get(), true) &&
! Find(ATTR_BROKER_STORE_ALLOW_COMPLEX) )
{
Error("&backend only supports atomic types as table value");
}
if ( Find(ATTR_EXPIRE_FUNC ) )
{
Error("&backend and &expire_func cannot be used simultaneously");
@ -655,11 +672,18 @@ void Attributes::CheckAttr(Attr* a)
}
// Temporary since Broker does not support ListVals - and we cannot easily convert to set/vector
if ( type->AsTableType()->GetIndexTypes().size() != 1 )
if ( type->AsTableType()->GetIndexTypes().size() != 1 && ! Find(ATTR_BROKER_STORE_ALLOW_COMPLEX) )
{
Error("&broker_store only supports one-element set/table indexes");
}
if ( ! type->AsTableType()->IsSet() &&
! input::Manager::IsCompatibleType(type->AsTableType()->Yield().get(), true) &&
! Find(ATTR_BROKER_STORE_ALLOW_COMPLEX) )
{
Error("&broker_store only supports atomic types as table value");
}
if ( Find(ATTR_EXPIRE_FUNC ) )
{
Error("&broker_store and &expire_func cannot be used simultaneously");
@ -668,8 +692,21 @@ void Attributes::CheckAttr(Attr* a)
{
Error("&broker_store and &read_expire cannot be used simultaneously");
}
if ( Find(ATTR_BACKEND) )
{
Error("&backend and &broker_store cannot be used simultaneously");
}
break;
}
case ATTR_BROKER_STORE_ALLOW_COMPLEX:
{
if ( type->Tag() != TYPE_TABLE )
{
Error("&broker_allow_complex_type only applicable to sets/tables");
break;
}
}
case ATTR_TRACKED:
// FIXME: Check here for global ID?
break;